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

Latest commit

 

History

History
94 lines (60 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

94 lines (60 loc) · 4.52 KB
Raw

Contributing to PayID

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to PayID and associated packages hosted in the PayID Organization

Code of Conduct

This project and all participants are governed by the PayID Code of Conduct.

Issue Reporting Guidelines

If you've found a bug or want to request a new feature, please create a new issue or a pull request on GitHub.

Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that's time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues.

Reporting Vulnerabilities

If you have found a vulnerability, please read our Vulnerability Disclosure Policy to learn how to responsibly report the vulnerability.

Pull Request Guidelines

  • We believe in small PRs. An ideal PR is <= 250 lines of code, so it can be easily reviewed.
  • Not all functionality can fit in a 250 LoC PR. For those cases, we use Stacked PRs. This lets each standalone slice of functionality be easily reviewed, while clearly showing the relationship between features. Writing small PRs in a stack also lets you get approval for important architecture/design decisions before writing 2000 lines of code of functionality based on your initial assumptions.
  • All PRs should be made against the master branch, unless stacking.
  • It's ok to have multiple small commits as you work on the PR - Github will automatically squash your commits before merging.

Adding New Features

  • Add accompanying test cases.
  • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before beginning work.

Fixing Bugs

  • Provide a detailed description of the bug in the PR.
  • Add one or more regression tests.

Versioning

The PayID reference implementation itself follows Semantic Versioning, and this is the version that is referenced by Github Releases and in the package.json file.

The PayID Protocol itself is versioned in a {major}.{minor} version, and this will be referenced in the CHANGELOG and Github Releases where appropriate. In the codebase, the supported protocol versions live in config.ts.

The RESTful CRUD API for interacting with PayIDs on the server is versioned as well, using a YYYY-MM-DD version, as many other RESTful APIs use for their version headers. This version will be referenced in the CHANGELOG and Github Releases where appropriate as well, and also lives in config.ts.

Development Setup

You will need NodeJS v12 or higher, and npm.

You will also need a local Postgres database running. The specifics can be set as environment variables read in config.ts.

After cloning the repo, run:

$ npm install # To install dependencies of the project

Commonly Used NPM Scripts

# Boot up the Node.js / Express PayID server locally
$ npm run start

# Run the full test suite
$ npm run test

# Lint the code, auto-fixing any auto-fixable problems
$ npm run lint

# Boot up a development database
# (A Postgres database in a Docker container configured to run with PayID)
$ npm run devDbUp

# Boot up a full development environment
# (A database & PayID server in 2 separate Docker containers)
$ npm run devEnvUp

# Bring down the development environment
$ npm run devDown

There are other scripts available in the scripts section of the package.json file.