Contributing Guidelines

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.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open and 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

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before starting a pull request, please ensure that:

You open an issue first to discuss any significant work - we would hate for your time to be wasted.
You are working against the latest source on the develop branch.
You check existing open and merged pull requests to make sure someone else hasn't addressed the problem already.

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 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.
Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional documentation on forking a repository and creating a pull request.

Repo branch and tag structure

Active development occurs under the develop branch.

Bottlerocket uses both tags and branches for release alignment. Numbered releases are always associated with tags that mirror the full SemVer 3-digit version number (e.g. 1.7.2). Branches are for patching only: if a patch is required, a branch will be cut for that minor release line (e.g. 1.7.x). As a consequence, some previous minor versions may not have a branch if they never required a subsequent patch.

Filename case conventions

Bottlerocket follows a few basic filename case conventions:

All extensions are lowercase,
Build related configuration files always start with a capital letter (e.g. Infra.toml, Release.toml),
All caps is used for documents and licenses (e.g. PUBLISHING.md, TRADEMARKS.md),
All lower case is used for all other files (e.g. sample-eksctl.yaml, main.rs).

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As this repository uses GitHub issue labels, looking through issues labeled 'good first issue' or 'help wanted' is a great place to start.

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 opensource-codeofconduct@amazon.com with any additional questions or comments.

Security issue notifications

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.

Licensing

See the COPYRIGHT file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!