43 lines (31 loc) · 1.44 KB

Contributing

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

Development Workflow

Fork this repository
Create a new branch: git checkout -b feature/your-feature-name
Make your changes
Check and fix code style and formatting issues: make lint
Run checks: make test
Build the project: make build
Commit your changes using the conventions below
Push your branch to your fork
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

Update documentation if needed
Ensure all tests pass
Address any feedback from code reviews
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.