CONTRIBUTING.md

Contributing

Everyone is welcome to improve this project. Here's how you can help:

Reporting Issues

• Open an issue here if you find a bug or have a feature request.

Pull Requests

1. Fork the Repo: Fork the project and clone your fork.

   git clone https://github.com/your-username/retroloop.git

2. Create a New Branch: Create a new feature branch for your work.

   git checkout -b my-feature-branch

3. Make Changes: Add or edit code. Commit your changes using conventional commit prefixes like feat:, fix:, chore:, etc.

   git add .
   git commit -m "feat: add some feature"

4. Push to GitHub: Push your feature branch to your fork.

   git push origin my-feature-branch

5. Create a Pull Request: Go to the GitHub page of your fork and click "Create pull request". Provide a description explaining the scope of the changes and what has been modified.

Code Style

• Use pnpm lint to enforce code style. Run it before submitting a pull request.

Testing

• Add unit and integration tests for any new features where applicable and make sure all tests pass by running pnpm test:unit and pnpm test:integration.

Recognition

• All contributors will be recognized through Github