Skip to content

Contribute to Shelf ​

We really appreciate your interest to contribute to Shelf! Any kind of contribution is highly appreciated, not only coding ☺️. Wondering what is up for grabs? Check out those issues: https://github.com/Shelf-nu/shelf.nu/labels/Open for contibutions

Prerequisites: Node 16 (or newer) installed in your computer.

  1. Fork this repository and clone your fork.
  2. Follow the Get started guide to setup your local repository.
  3. Make any changes you consider to the project.
  4. Make sure tests pass by running npm run validate
  5. Commit and push to your fork.
  6. Open a Pull Request detailing the changes.
  7. 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.

Released under the AGPL-3.0 License.