Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 2 KB
Raw

Contributing guide

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

Getting started

Find issue

Head over to the project board to see TODO issues. Find one that you find suitable to work on. Feel free to assign it to yourself and move it to "In Progress" column.

Make changes locally

  • Create a branch and add commits to it.
  • Keep minimum changes in a commit, so that review is easier.
  • Write a good commit message describing your changes in a commit.
  • You may use conventional commits format.

Pull Request

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

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Other devs 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 branch, 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 🎉🎉