Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 2.11 KB
Raw

Contributing Guide

This document shows you how to get the project, run all provided tests and generate a production-ready build. It must focus on the bare minimum to help a new developer to make a change with the least effort possible.

Dependencies

To make sure that the following instructions work, please install the following dependencies on you machine:

Installation

Testing

Linting

Unit testing

Integration testing

Building

Developing

Contributing/Submitting changes

  • Check out a new branch based on main and name it to what you intend to do, based on the company's branch naming conventions:

    • Example:

      git checkout -b BRANCH_NAME origin/main

      If you get an error, you may need to fetch main first by using

      git remote update && git fetch

    • Use one branch per fix/feature

  • Make your changes

    • Make sure to provide a spec for unit tests (and any other relevant tests).
    • When all tests pass, everything's fine.

  • Commit your changes

    • Please provide a git message that explains what you've done based on the company's commit conventions.
    • Commit to your local branch.

  • Make a pull request

    • Make sure you send the PR to the main branch.
    • Github actions will verify your code.
    • A code owner must approve your change before it can be merged.

If you follow these instructions, your PR will land pretty safely in the repo once approved.