CONTRIBUTING.md

Contributing to bkit

Thank you for your interest in contributing to bkit!

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Issues

1. Check if the issue already exists
2. Create a new issue with a clear description
3. Include reproduction steps if reporting a bug

Pull Requests

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Branch Naming

• feature/* - New features
• fix/* - Bug fixes
• docs/* - Documentation changes
• refactor/* - Code refactoring

Commit Messages

We follow Conventional Commits:

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation
• refactor: - Code refactoring
• test: - Tests
• chore: - Maintenance

Review Process

• All PRs require review from at least one maintainer
• Only admin team members can merge to main
• PRs must pass all CI checks

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Questions?

Feel free to open a discussion or contact us at contact@popupstudio.ai