Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

64 lines (38 loc) · 3.27 KB
Raw

Welcome to contributing guide

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.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

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

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 locally

  1. Fork the repository.
  2. Create a working branch
  3. See the development guide.

Commit your update

Adherence to Conventional Commits is required.

You can use GitHub issue ID in commit body prefixed with #. E.g. #2

Full commit message:

chore: use GitHub issue id in conventional commits

#2

Pull Request

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

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments.
  • 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 🎉🎉