Skip to content

Commit

Permalink
doc: Updated PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
ShrimpCryptid committed Dec 25, 2024
1 parent 0e04278 commit 1e1d674
Showing 1 changed file with 42 additions and 6 deletions.
48 changes: 42 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,45 @@
**Pull request recommendations:**
# Problem

- [ ] Name your pull request _your-development-type/short-description_. Ex: _feature/read-tiff-files_
- [ ] Link to any relevant issue in the PR description. Ex: _Resolves [gh-##], adds tiff file format support_
- [ ] Provide description and context of changes.
- [ ] Provide relevant tests for your feature or bug fix.
- [ ] Provide or update documentation for any feature added by your pull request.
What is the problem this work solves, including
[Link to story or ticket](https://my-tracking-system.url/ticket-number)

# Solution

What I/we did to solve this problem

with @pairperson1

## Type of change

Please delete options that are not relevant.

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- This change requires a documentation update
- This change requires updated or new tests

## Change summary:

- Tidy, well formulated commit message
- Another great commit message
- Something else I/we did

## Steps to Verify:

1. A setup step / beginning state
1. What to do next
1. Any other instructions
1. Expected behavior
1. Suggestions for testing

## Screenshots (optional):

Show-n-tell images/animations here

## Keyfiles (delete if not relevant):

1. main file/entry point
2. other important file

Thanks for contributing!

0 comments on commit 1e1d674

Please sign in to comment.