Guidelines for contributing
Thank you for your interest in contributing to the IoT Atlas! We greatly value feedback and contributions from our community.
Please read through this document before you submit any pull requests or issues. It will help us work together more effectively.
What to expect when you contribute
When you submit a pull request, our team is notified and will respond as quickly as we can. We'll do our best to work with you to ensure that your pull request adheres to our style and standards. If we merge your pull request, we might make additional edits later for style or clarity.
The documentation in this repository are not published directly to the IoT Atlas website. If we merge your pull request, we'll publish your changes to the documentation website as soon as we can, but they won't appear immediately or automatically.
We look forward to receiving your pull requests for:
- New content you'd like to contribute (such as new designs, considerations, or examples)
- Inaccuracies in the content
- Information gaps in the content that need more detail to be complete
- Typos or grammatical errors
- Suggested rewrites that improve clarity and reduce confusion
Note: We all write differently, and you might not like how we've written or organized something currently. We want that feedback. But please be sure that your request for a rewrite is supported by the previous criteria. If it isn't, we might decline to merge it.
How to contribute
To contribute, send us a pull request. For small changes, such as fixing a typo or adding a link, you can use the GitHub Edit Button. For larger changes:
- Fork the repository.
- In your fork, make your change in a branch that's based on this repository's master branch.
- Commit the change to your fork, using a clear and descriptive commit message.
- Create a pull request, answering any questions in the pull request form.
Before you send us a pull request, please be sure that:
- You're working from the latest source on the master branch.
- You check existing open, and recently closed, pull requests to be sure that someone else has not already addressed the problem.
- You create an issue before working on a contribution that will take a significant amount of your time.
For contributions that will take a significant amount of time, open a new issue to pitch your idea before you get started. Explain the problem and describe the content you want to see added. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it. We don't want you to spend a lot of time on a contribution that might be outside the scope of the IoT Atlas or that is already in the works.
Finding contributions to work on
If you'd like to contribute, but don't have a project in mind, look at the open issues in this repository for some ideas. Any issues with the help wanted or enhancement labels are a great place to start.
In addition to written content, we really appreciate new examples for each design, such as examples for different platforms or environments, and code samples in additional languages.
Code of conduct
This project has adopted the Amazon Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact firstname.lastname@example.org with any additional questions or comments.
Security issue notifications
If you discover a potential security issue, please notify AWS Security via our vulnerability reporting page. Please do not create a public issue on GitHub.