Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1.22 KB
Raw

Contributing

Thank you for helping improve Antenna Pattern Lab.

Ways to contribute

  • report a reproducible bug;
  • propose or implement a focused feature;
  • improve tests, documentation, accessibility, or translations;
  • review an open pull request.

For significant behavior or data-model changes, open an issue before investing in an implementation.

Development workflow

  1. Fork the repository and create a branch from main.
  2. Install the development dependencies with pip install -e ".[dev]".
  3. Make a focused change and add or update tests.
  4. Run python -m pytest.
  5. Open a pull request using the repository template.

Do not commit build output, installers, virtual environments, databases, logs, or signing material.

Pull requests

All changes, including maintainer changes, are merged through pull requests. The main branch requires passing checks and approval from the repository owner. Stale approvals are dismissed when new commits are pushed.

Keep each pull request small enough to review. Explain user-visible behavior, testing performed, security or privacy implications, and documentation changes.

By contributing, you agree that your contribution is licensed under the MIT License used by this project.