Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

19 lines (13 loc) · 1.16 KB
Raw

We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏

Instructions

These steps will guide you through contributing to this project:

  • Fork the repo

  • Clone it and install dependencies

      git clone https://github.com/YOUR-USERNAME/gridcoin-rpc
  npm install

Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working. Keep in mind we use Conventional Commits so either use provided format eiter just use npm run commit command so it will provide nice wizzard for the commit format. All commits messages will be used to generate changelog. Please keep updating JSDOC comments for function if necessery as it will be used for documentation. Please do not update package version as it is done automatically with semantic release.

Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).