Contribution guide
Thank you for your interest in contributing to AtlasOS! This guide will help you understand how to contribute effectively to our projects. We appreciate all contributions, big and small.
Our contribution platform
Atlas uses GitHub to manage everything. Please note that our documentation does not contain instructions on how to use GitHub or Git; if you’re unfamiliar with them, see the GitHub quick-start guide first.
A Code of Conduct applies to each Atlas repository. Please read this before contributing.
Areas of contribution
Atlas Playbook
Core AtlasOS source code and scripts
Documentation
Help improve the docs
Atlas Toolbox
Toolbox utility development
Testing Guide
What to test and how
Report Issues
How to report bugs
How to make changes
Unsure if people will like your change?
Consider proposing the change in the Discord or GitHub issues first. Remember that it’s okay to make mistakes—people will provide feedback in your pull requests. Don’t worry too much about getting everything perfect on the first try.
Follow these steps to contribute:
- Fork or branch - Create a fork (external contributors) or branch (team members) in the repository
- Make your changes - Implement your improvements or fixes
- Submit a pull request - Create a PR to the primary branch of the repository
- Wait for reviews - Wait for at least two reviews (depending on change size)
- Team members only require one review
- Merge - Once approved, your PR will be squash-merged (all commits combined into one)
Info
Team members may skip pull requests for uncontroversial, well-tested changes that don’t require review.
Formatting
Before a pull request, ensure that:
- Your changes comply with the general formatting of a repository
- There’s a minimal amount of mistakes; check grammar and anything else important
- For YAML changes, verify that they are valid using a linter
Commit signature verification
We highly recommend setting up commit signature verification. It marks your commits as Verified, indicating that someone else has not forged commits.
Check out this detailed guide on setting up verified commits.
Conventional commits
We recommend using Conventional Commits in Atlas repositories for consistency and more descriptive commits.
Conventional Commits is a commit message format that helps make the commit history more readable and easier to navigate.
Example: feat: ✨ add fAllowFullControl