Contribution guide

On this page

This guide is for anyone who wants to improve Atlas. 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 haven’t used Git or GitHub before, complete the GitHub quick-start guide first.

Read the Code of Conduct before contributing.

Areas of contribution

How to make changes

Propose it in Discord or GitHub issues first. Mistakes are fine: reviewers give feedback in pull requests, and you don’t need to get everything right first time.

Follow these steps to contribute:

  1. Fork or branch: create a fork if you’re an external contributor, or a branch if you’re a team member.
  2. Make your changes: keep each pull request to one fix or improvement.
  3. Submit a pull request: open it against the primary branch.
  4. Wait for reviews: external contributions need at least two reviews, and team members’ need one.
  5. Merge: after approval, a maintainer squash-merges the pull request into one commit.

Team members may skip pull requests for uncontroversial, well-tested changes that don’t need review.

Before you submit

  • Match the repository’s formatting and house style.
  • Check grammar and spelling. Atlas documentation and interface copy use British English.
  • In the Atlas repository, run the checks in the contributor quick start and the testing reference that cover your change.

Commit signature verification

Set up commit signature verification so your commits show as Verified. See this guide to verified commits.

Conventional commits

Use Conventional Commits in Atlas repositories, in the form type(scope): summary. Write the summary in the imperative and in lower case, without a full stop.

Example: fix(toggles): check the active power plan in Atlas health

Conventional Commits extension for Visual Studio Code then

Search documentation

Search the docs

Pages, guides, and reference