Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (56 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.8 KB
Raw

Contributing to httpcatcher-parser

Thank you for your interest in contributing! 🎉
This project is under the AGPL-3.0-only license. Please make sure you are comfortable with its terms before contributing.

Development setup

  • Python 3.10–3.13 supported
  • Package manager: uv

Clone and install

git clone https://github.com/mkb79/httpcatcher-parser.git
cd httpcatcher-parser
uv tool install --path .

Run in dev mode

uv run hc-parser ./samples/input.session --report-gaps
uv run hc-har ./samples/input.session --outfile out.har --include-payload

Coding standards

  • Language: English only (code, comments, docstrings)
  • Docstrings: Google style
  • Formatting/Linting: ruff recommended

Example pyproject.toml snippet:

[tool.ruff]
target-version = "py310"
line-length = 100
extend-select = ["I", "UP", "B", "SIM", "PL", "RUF"]

Submitting changes

  1. Fork the repository and create a feature branch: 
    git checkout -b feature/my-change
  2. Make your changes (ensure code is PEP-compliant).
  3. Add or update tests if applicable.
  4. Commit with a clear message: 
    git commit -m "Add HAR option to skip decompression"
  5. Push and open a Pull Request.

Reporting issues

  • Use the GitHub Issues tracker.
  • Include:
    • Python version and platform
    • Exact CLI command used
    • Traceback or error log
    • Sample (if possible, anonymized)

Legal

By submitting contributions, you agree that your code will be licensed under the same license as this project: AGPL-3.0-only.

Thank you for helping improve httpcatcher-parser! 🚀