CONTRIBUTING.md

Contributing to Detecto

First of all, thank you for taking the time to contribute! 🎉

Getting Started

1. Fork the repository and clone your fork locally:

   git clone https://github.com/vladzima/detecto.git
   cd detecto
   npm install

2. Make sure you have Node.js and npm installed.

3. Create a branch for your changes:

   git checkout -b feature/your-feature-name

Development Workflow

1. Make your changes in the new branch.

2. Run linting to ensure code style:

   npm run lint

3. Once you're done, commit your changes using Commitizen:

   git add .
   npm run commit

   • We use Commitizen to ensure consistent commit messages. Follow the prompts to create a meaningful commit message.

4. Push your branch to GitHub:

   git push origin feature/your-feature-name

5. Create a Pull Request (PR) on GitHub:

   • Include a detailed description of your changes.
   • Reference related issues if applicable.

Code Style Guidelines

• We follow ESLint for consistent code quality.
• Please ensure your code matches the existing formatting and conventions.

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue.

---

Thanks for helping to make Detecto better! 💡