Thank you for considering contributing to our project! To ensure a smooth collaboration, please follow the guidelines outlined below.
- Fork the repository.
- Clone your forked repository:
git clone https://github.com/tembell/paresseux.git
- Create a new branch for your feature or bug fix (feat/fix/chore/docs...):
git checkout -b feat/feature-name
We use Conventional Commits for our commit messages. Please adhere to this convention when making changes.
Example:
git commit -m "feat: add new feature"
git commit -m "fix: resolve a bug"
Don't hesitate to add a commit description
We use Changesets to manage versioning and generate release notes. Please create a changeset for each commit.
Example:
pnpm changeset
- Ensure your code adheres to the project's coding standards.
- Make sure all tests pass.
- Update the documentation if necessary.
- Push your changes to your forked repository.
- Submit a pull request to the
main
branch of the original repository.
To release a new version, use the following command:
pnpm changeset version