Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.24 KB

File metadata and controls

32 lines (20 loc) · 1.24 KB

Contributing

All contributions to this project are subject to the MIT Licence. By submitting a contribution, you agree to license your work under these terms.

Contribution Process

1. Issue First

All contributions from outside the core team require an Issue First approach. Before submitting a pull request (PR), you must:

  1. Open an issue in the repository.
  2. Ensure the issue includes:
    • Clear problem statement: Describe the issue or feature request.
    • Reproduction steps: If reporting a bug, provide steps to reproduce it.
    • Proposed approach: Outline your suggested solution or implementation.
    • Why this change matters: Explain the impact or necessity of the change.
    • Tag @sanger/psd-developers in the issue to bring it to the attention of a maintainer.
    • Wait for the issue to be assigned or approved by a maintainer.

2. Pull Request

Once your issue is approved:

  1. Fork the repository and create a branch for your changes.
  2. Submit a PR referencing the approved issue.
  3. Ensure your code adheres to the project's coding standards and passes all CI checks.

3. Review

Maintainers will review your PR. Address any feedback before merging.