A big welcome and thank you for considering contributing to Paycrest! It’s people like you that make it a reality for users.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by welcoming your contributions, addressing your issue, assessing changes, and helping you finalize your pull requests.

Quicklinks

Code of Conduct

We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Getting Started

Contributions are made to our repos via Issues and Pull Requests (PRs). A few general guidelines that cover both:

Fork and Pull Workflow

In general, we follow the "fork-and-pull" Git workflow

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch following the [standard convention commit spec](https://www.conventionalcommits.org/en/v1.0.0/#:~:text=fix%3A a commit of the,CHANGE%3A %2C or appends a !)
  5. Following any formatting and testing guidelines specific to this repo
  6. Push changes to your fork