PRs

This document describes our best practices with Pull Requests that contribute to CRUK repos.

:::

info

The following content is recommended.

Rationale

Pull requests are a critical part of our work. They provide a standardised interface for code reviews, progress marking, issue tracking, and simplified testing suites and deployments.

Description

1. The name of the PR you create or generate should have some meaning. Ideally the PR name will be the same as the commit message header.
2. Include a description, test information, and if applicable, include any helpful links such as JIRA tickets, UI references, GitHub issues or external resources. In order to help reviewers and make it simpler to see what has changed, you may also add screenshots for UI updates or any link or blog that you referred to.
3. Assign the appropriate engineer/s to review.
4. Assign QA to review. Don't forget to put the label "Ready for Test".
5. If using a squash and merge strategy, add a description when the PR is being merged.

Here you can find journey for contributing Github repo and mentioned above steps.

Examples

PR Description and Test Details: ✔️

# Description
Add product reference data  API
This API has been added such that
the admin console can retrieve a list
of valid products to display in the
fulfilment and email edit page drop
down selector.
JIRA https://jira.cancerresearchuk.org/browse/AM-1941
# Testing
- [x] `npm run test`
- [ ] `npm cypress run`
- [x] `manual verification`