Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 874 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 874 Bytes

Contributing

Getting Started

git clone https://github.com/yantrikos/agentweb
cd agentweb
pip install -e .
python -m unittest discover tests -v

How to Contribute

  • Bug reports: Open an issue with reproduction steps, Python version, and error output
  • Bug fixes: Fork, fix, test, submit PR
  • Features: Open an issue to discuss before implementing
  • Tests: More coverage is always welcome
  • Documentation: Improvements to README, docstrings, examples

Pull Requests

  1. Fork and create a feature branch
  2. Make changes
  3. Ensure all tests pass
  4. Submit PR with clear description of what and why

Code Style

  • Python 3.9+ compatible
  • Type hints where helpful
  • Docstrings for public methods
  • No unnecessary dependencies

License

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