Skip to content

Latest commit

 

History

History
11 lines (6 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

11 lines (6 loc) · 1.54 KB

Contributing to PycWB

Start with the contribution guide or its source.

Use Python 3.11 or newer. For a development environment, install the checkout with python -m pip install -e ".[test]". Install documentation tools with python -m pip install -r docs/requirements.txt, then run make doc-check. Run lint and mypy in the separate Python 3.11 environment described in the build/test guide.

Explain the problem and resulting behavior, add relevant regression tests, and include brief release notes for user-visible changes in the MR/PR description. Update affected guides, migration examples and scientific behavior documentation with the change. Maintainers consolidate CHANGES.md from merged MR/PR descriptions when preparing a release; routine contributions do not need to edit it. The scientific tests may require additional fixtures; see the build/test guide.

The GitHub and LIGO GitLab repositories are mirrored. Fork either repository and submit a GitHub pull request or GitLab merge request. Contributors outside LVK can use GitHub without an LVK account.

Questions and bug reports: use GitHub issues or GitLab issues, or email yumeng.xu@ligo.org if you cannot access either tracker. See SUPPORT.md.