Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.73 KB

File metadata and controls

29 lines (22 loc) · 1.73 KB

Contributing

Getting Started

Full instructions on how to build and test the project is available on the README.

Contribution expectations

The following expectations apply to each PR:

  1. The PR and branch are named for automatic linking to the most relevant JIRA issue (for example, JRA-123 Adds foo for PR title and jra-123-adds-foo for branch name).
  2. Reviewers are selected to include people from all teams impacted by the changes in the PR.
  3. The PR has been assigned to the people who will respond to reviews and merge when ready (usually the person filing the review, but can change when a PR is handed off to someone else).
  4. The PR is reasonably limited in scope to ensure:
    • It doesn't bunch together disparate features, fixes, refactorings, etc.
    • There isn't too much of a burden on reviewers.
    • Any problems it causes have a small blast radius.
    • Changes will be easier to roll back if necessary.
  5. The PR includes any required documentation changes, including README updates and changelog or release notes entries.
  6. All new and modified code is appropriately commented to make the what and why of its design reasonably clear, even to those unfamiliar with the project.
  7. Any incomplete work introduced by the PR is detailed in TODO comments which include a JIRA ticket ID for any items that require urgent attention.

Issues

Please report any issues to Issues.

Policies

Contributions to this project must comply with Section 508 accessibility standards.

Public Domain

This project is subject to the Creative Commons Zero 1.0 International License.