Skip to content

Contributing

Thank you for your interest in contributing to our project! This guide will help you get started with the development process.

Development Workflow

  1. Fork this repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Check and fix code style and formatting issues: make lint
  5. Run checks: make test
  6. Build the project: make build
  7. Commit your changes using the conventions below
  8. Push your branch to your fork
  9. Open a pull request

Commit Message Conventions

We follow Conventional Commits for clear and structured commit messages:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code changes that neither fix bugs nor add features
  • perf: Performance improvements
  • test: Adding or updating tests
  • chore: Maintenance tasks, dependencies, etc.

Pull Request Guidelines

  1. Update documentation if needed
  2. Ensure all tests pass
  3. Address any feedback from code reviews
  4. Once approved, your PR will be merged

Code of Conduct & Security

Please be respectful and constructive in all interactions within our community and follow the CODE_OF_CONDUCT and SECURITY guidelines.

Questions?

If you have any questions, please open an issue for discussion.