Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 2.17 KB
Raw

Contribution Model

Thanks for taking the time to contribute!

Code of Conduct

This project and everyone participating in it is governed by the Atom Code of Conduct. By participating, you are expected to uphold this code.

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use GitHub Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use GitHub Flow). We actively welcome your pull requests:

  • Create feature requests and discuss the scope.
  • Fork the repo and create your branch from master.
  • If you’ve added code that should be tested, add tests.
  • If you’ve changed APIs or design, update the documentation.
  • Create a draft pull request (not yet ready for review, triggers CI build).
  • Ensure the e2e tests pass (wait for GitHub status checks).
  • Mark that pull request as ready for review.

Quality Standards

It is important to keep the quality bar high and ensure all of us follow best practices and security, so the code is solid and can be reused by other people. Below you can find some quality standards.

General Contribution

  • Break down your pull request into smaller pieces, less code is easier to review. Most of PRs should fall under 200 lines of code changes unless specifically justified otherwise.
  • Add descriptive comments and labels to pull requests and issues.
  • Ensure end to end tests are passing.
  • commit message should follow these best practices, specifically: start with a subject line and reference an issue number e.g. "Fixes #245" or "Closes #111"

Large Architectural Changes

In case of large change which requires significant engineering effort and introduces side effects, we suggest writing a design proposal document first.

Design proposal is simply a document that states what you propose to do including:

  • Problem statement
  • Description of potential solution
  • Side effects
  • Breaking changes

Keep in mind that a proposal is not a pitch, it needs to be technical.