Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (39 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

48 lines (39 loc) · 1.28 KB
Raw

Contributing

Thanks for your interest in code-stats. This project aims to be a well-crafted CLI tool for analyzing codebases, and contributions that align with that goal are welcome.

Getting Started

  1. Fork the repository.
  2. Clone your fork: 
    git clone https://github.com/mangodxd/code-stats.git
  3. Install in development mode: 
    pip install -e .
pip install pytest ruff
  4. Run the tests: 
    python -m pytest
  5. Run the linter: 
    ruff check src/ tests/

Development Guidelines

  • Keep the codebase minimal. No external dependencies for core functionality.
  • Write tests for new features. We use pytest.
  • Follow the existing code style. Run ruff before committing.
  • Comments should explain WHY, not WHAT. Good code is self-documenting.
  • Use Conventional Commits: feat:, fix:, docs:, test:, refactor:.

Pull Request Process

  1. Create a feature branch from main.
  2. Make your changes.
  3. Run the full test suite and linter.
  4. Update the CHANGELOG if adding or changing features.
  5. Submit a pull request with a clear description of what changed and why.

Reporting Issues

Open an issue on GitHub. Include the command you ran, the output you expected, and what actually happened. A minimal reproduction helps.