Contribution guide
Choose a project, make a focused change, and submit it through GitHub.
Our contribution platform
Atlas manages code, documentation, issues, and reviews on GitHub. If you have not used Git or GitHub, complete the GitHub quick-start guide first.
Read the Code of Conduct before contributing.
Areas of contribution
Core AtlasOS source code and scripts
Help improve the docs
Toolbox utility development
What to test and how
How to report bugs
How to make changes
Unsure if people will like your change?
Propose it in Discord or GitHub issues first. Mistakes are fine—reviewers will give feedback in pull requests. You don’t need to get everything right on the first try.
Follow these steps to contribute:
- Fork or branch – Create a fork (external contributors) or branch (team members)
- Make your changes – Implement your improvements or fixes
- Submit a pull request – Open a PR against the primary branch
- Wait for reviews – At least two reviews (team members need one)
- Merge – After approval, a maintainer squash-merges the pull request into one commit
Info
Team members may skip pull requests for uncontroversial, well-tested changes that don’t require review.
Formatting
Before submitting a pull request:
- Match the repository’s formatting
- Check grammar and fix mistakes
- For YAML changes, run a linter to verify validity
Commit signature verification
Set up commit signature verification so your commits show as Verified. See this guide for verified commits.
Conventional commits
Use Conventional Commits in Atlas repositories for consistent, descriptive commit messages.
Example: feat: add fAllowFullControl