Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Latest commit

 

History

History
48 lines (33 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.84 KB
Raw

Contributing to Revert

Thanks for taking the interest in contributing ♥. We really appreciate any support in making this project thrive.

Before getting started

  • Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.
  • Select an issue from here or create a new one
  • Consider the results from the discussion in the issue

Developing

  • The development branch is main. All pull request should be made against this branch.
  • If you need help getting started, join us on Discord.
  • Use Conventional Commits to keep everything nice and clean.
  • Choose your branch name using the issue you are working on and a conventional commit type.
  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch:

  • Create a new branch (include the issue id and something readable):

    git checkout -b feat/<feature-description>
  1. See the individual package's README for instructions on how to build each from source.

Building

Note Please be sure that you can make a full production build before pushing code or creating PRs.

  • Install the project dependencies by running:
yarn install
  • Next, you can build the project with:
yarn build

Contributing an API Integration

See https://docs.revert.dev/overview/developer-guide/contribute-an-api-integration for more on how to contribute an integration.