| title | Contributing to Shelf.nu |
|---|---|
| description | How to contribute to the Shelf.nu project |
We really appreciate your interest to contribute to Shelf! Any kind of contribution is highly appreciated, not only coding
Prerequisites: Node 16 (or newer) installed in your computer.
- Fork this repository and clone your fork.
- Follow the Get started guide to setup your local repository.
- Make any changes you consider to the project.
- Make sure tests pass by running
npm run validate - Craft your commit message using the Conventional Commits format. The
commit-msghook runscommitlintautomatically to ensure your message follows the convention. - Commit and push to your fork.
- Open a Pull Request detailing the changes.
- Request a review from someone in the shelf team
If you get stuck on any of these steps, open an issue or join us in our Discord for some extra help.