Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Bootstrapping the Project

# Clone the repository
git clone https://github.com/travix/ts-grpc-hmac.git
npm install

npm fun test

it's recommended to adjust/modify the example to test the changes locally.

./example/run.sh

Fork the repository and create your branch from main.
Configure and install the dependencies. npm install
Make sure the test pass on your machine. npm run all
Create a new branch: git checkout -b my-branch-name.
Make your change, add tests, and make sure the format and lint tests pass. npm run lint && npm run format && npm run test
Make sure to build the library. npm run build or I recommend using npm run all and you can pass the step 4.
Push to your fork and submit a pull request
Pat yourself on the back and wait for your pull request to be reviewed and merged.
The maintainers will review your pull request and either merge it, request changes to it, or close it with an explanation.