Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: format readme #40

Merged
merged 1 commit into from
Apr 19, 2024
Merged

chore: format readme #40

merged 1 commit into from
Apr 19, 2024

Conversation

saranyailla
Copy link
Member

Use this PR to list your component in the aws-greengrass-software-catalog repository. Update README file with your component details and provide other information as requested below.

PR checklist

  • Review the guidelines for contributing to this repository.
  • Check your code additions and commit messages don't fail the automated CI validation.
  • Fill in the requested information in all the following sections.

Description

Link to the component repository

Motivation and context

QA Detail - Instructions to verify component functionality

Acceptance criteria

Make sure your component home contains:

  • Requirements - AWS and non-AWS resources required on device and in customer's AWS account.
  • Instructions for installation of component, preferably "one-click or one-line".
  • Instructions around what settings can be configured along with examples of workable defaults.
  • Threat Modeling - List any potential security vulnerabilities for this component and how you've attempted to mitigate risks.
  • Troubleshooting guide to help resolve customer issues.
  • Instructions about how customers can report issues related to component and get them addressed.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@saranyailla saranyailla merged commit 31aa5f1 into main Apr 19, 2024
1 check passed
@saranyailla saranyailla deleted the format-readme branch April 19, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants