Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
- You are working against the intended Yocto Project release-next branch. Changes are no longer accepted direct to release branches.
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
- Typically bug fixes must already be accepted into the master branch before they can be backported to a release branch, unless the bug in question does not affect the master branch or the fix on the master branch is unsuitable for backporting.
To send us a pull request, please:
- Fork the repository.
- Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
- Ensure local tests pass.
- Commit to your fork using clear commit messages.
- Send us a pull request, answering any default questions in the pull request interface.
- Wait for a repository maintainer to look at your PR, run it in CI, test, and review. If additional changes or discussion is needed, a maintainer will get back to you, so please stay invovled in the conversation. Note: PRs from forks will not run in CI automatically for security reasons. If you make a PR and see that CI is left pending, this is normal and expected.
- After your pull request is merged into release-next there will be done some additional testing and after that is successfully finished it will be merged into the release branch. Usually this will take 24h for master and 7 days for release branches.
GitHub provides additional document on forking a repository and creating a pull request.
With every pull request following tests are performed:
All recipes are tested to build with qemuarm, qemuarm64, qemux86-64.
We like to have a ptest for every recipe. With every pull request we ptest with the different architectures we support. If there is a ptest it must pass. To get an idea how to write an ptest just grep for it in the layer.
We think having the same "coding" style for recipes is a good idea. Therefore we test with oelint-adv for errors.
Meta-aws is Yocto project compatible. To keep this status we test this.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
We may ask you to sign a Contributor License Agreement (CLA) for larger changes.