Thanks for your interest in contributing to Lazykit. We're happy to have you here.
We use pnpm
as the package manager. You can install it by running:
npm install -g pnpm
Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.
If you need any help, feel free to reach out to @jrTilak
- Fork the repository.
- Clone the forked repository.
- Run
pnpm install
to install the dependencies. - These are some scripts you can run:
- Make your changes.
- Run
pnpm test
to make sure the tests pass. - Commit your changes using the following convention:
feat: Added a new feature
fix: Fixed a bug
docs: Updated the docs
refactor: Refactored the code
test: Added a new test
chore: Updated the build process
- etc
- Push your changes to your fork.
- Create a pull request to the
dev
branch. - Wait for the review and merge.