Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 2.09 KB
Raw

Contribution Guidelines

We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Submitting a fix
  • Revise documentation
  • Add a resource
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Revise documentation

  1. Fork the repo and create your branch from master.
  2. Revise the documentation in the docs folder.
  3. Issue that pull request!

Adding a resource

Please make sure to add English resources only. Also, no affiliate links. We want to keep the list as unbiased as possible.

  1. Click on the Edit this page link at the bottom of the page.
  2. On the GitHub page, click on the pencil icon to edit the file.
  3. Add the resource to the appropriate section.
  4. Markdown syntax: [Link Title](URL)

Please make sure to keep the format consistent with the rest of the list.

  1. Issue that pull request!

Contributions to the documentation are much appreciated!

Report bugs or Broken Links using Github's issues

We use GitHub issues to track public bugs or Broken Links. Report by opening a new issue; it's that easy!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Where you saw the bug or broken link
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for aws-solutions-architect