feat: initial commit of PR template #13
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue(s) does this pull-request address?
Closes: #12
Description
This is a first draft of a PR template for the project intended for review/discussion and potential modification prior to being merged. The intention of the template is to guide contributors towards behaviour that is consistent with the project and to do this in as light-a-weight way as possible. The template covers 3 main areas:
A link to an issue - ideally we have atomic PRs so we have 1 issue and 1 resolving PR that should keep changes small and easier to review. The issue serves as the problem description and discussion space for potential solutions. In some circumstances there may not be an issue raised in which case the linked issue above could be replaced with a summary and description of the problem. However, issue raising is preferred.
Description - this is the space for the PR contributor to talk to the maintainers and describes how the PR resolves the linked issue.
Checklist - a tick list of items to prompt the PR contributor to behave according to the project's standards. Any items not ticked serve as a visual clue for the maintainers to think about whether those items are required for this type of PR.
Checklist
yarn lint
oryarn lint:fix
yarn format
oryarn format:fix
yarn test:unit
yarn test:e2e
Note: tests and documentation not required