Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (59 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

80 lines (59 loc) · 1.91 KB

Contributing to Commitrix 🤝

Thank you for considering contributing! We welcome issues, feature requests, and pull requests.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold a respectful, inclusive environment.

Development Workflow

  1. Fork the repo and clone your fork.
  2. Create a branch: 
    git checkout -b feat/my-feature
  3. Install dependencies: 
    npm install
  4. Run tests before pushing: 
    npm test
  5. Submit a Pull Request with a clear description.

Commit Guidelines

We enforce semantic commits via this project itself 🎯

Examples:

  • feat(api): add user authentication
  • fix(ui): correct button alignment
  • docs: update installation instructions

❌ Bad:

  • fix bug
  • added stuff

Issue Guidelines

Bug Reports

When reporting bugs, please include:

  • Clear description of the issue
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment (OS, Node.js version, Git version)
  • Sample commit messages that cause issues

Feature Requests

For new features, please describe:

  • The problem you're trying to solve
  • Proposed solution or API
  • Use cases and examples
  • Impact on existing functionality

PR Guidelines

  • Keep changes small and focused.
  • Include tests where possible.
  • Update docs if behavior changes.
  • Ensure CI checks pass before requesting review.

Development Roadmap

Interested in contributing? Here are some areas we'd love help with:

  • 🌍 Multi-language support - Internationalization
  • 🤖 AI integration - Smart commit suggestions
  • 📦 Monorepo support - Workspace-aware validation
  • 🎨 IDE extensions - VS Code, IntelliJ plugins
  • 📈 Advanced analytics - Team insights and metrics

Feel free to suggest new features or pick any of these items!