Thanks for taking the time to contribute! 🎉
Contributing goes a long way, there are lots of ways you can still help, even if you can't contribute to the code. All methods are outlined in the sections below, but the two main things other than code are testing and creating issues.
The easiest way to contribute! By just using the software, you're already helping the project grows. Simply use and let us know if you run into problems, or there's some use case you would like to use it for but are not yet covered, this is the most common way we uncover bugs or implement new features. Open a new issue or start a new discussion.
Documentation is especially helpful! You can add something that hasn't been covered or is missing in the docs and help guide others with your experience. The source for the documentation lives in the docs directory.
Follow this if you're looking to contribute to the code.
First step is to prepare your environment and make sure that pnpm is available to use, you can follow their installation guide, but if you're using Node.js above v16.13, you can simply enable corepack.
corepack enable
corepack prepare pnpm@latest --activateThe next step is to checkout the code by forking and cloning the repository.
The only script to run is "dev", which will run the dev server for the documentation site.
For maintainers of the project.
- prepare a new release draft with a new tag
- bump version in
package.jsonand commit with~ vX.Y.Z - publish release draft and title release with
X.Y.Z