Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 4.38 KB
Raw

Contributing

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README.

Getting started

The following are instructions on the different ways you may contribute to the project.

Issues

Create a new issue

If you spot a problem with the microservices, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.

Make Changes

Make changes locally

  1. Fork the repository.
  1. Follow the instructions for how to setup and run the specific microservice(s) you want to change (see each microservice's directory for details)
  2. Create a working branch and start making changes!

Commit your changes

The repository uses pre-commit hooks to style and lint the code. Specifically, we use the pre-commit framework. Make sure you have that installed on your machine before proceeding.

Once you have pre-commit installed, setup our pre-commit hooks by running the following command in the root of the repository:

pre-commit install

Now you can commit your changes. This will automatically run the pre-commit hooks. If there are errors, some may be fixed automatically but others may require manual intervention. If any errors require intervention, the commit will fail and you will need to fix the errors before trying to commit again. When committing after fixing errors you can use the same commit message as the previous commit because the previous commit failed and therefore wasn't added to the commit log.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link the PR to an issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 We thank you for your contribution ✨.