From c69b7da1b53efe28278e5c84c5f4cc4b441b3040 Mon Sep 17 00:00:00 2001 From: Brian Kroth Date: Tue, 1 Oct 2024 17:47:16 -0500 Subject: [PATCH] Add a Github PR template (#862) Adds a Github PR template to try and make it easier for contributors to understand what information is expected in a PR. --- .github/pull_request_template.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..c21c2a55ef --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +# Pull Request + +## Title + +_A brief, descriptive title of your changes (e.g., `Fix bug in data parser for edge cases`)_ + +--- + +## Description + +_Provide a concise summary of what this PR does. Explain why this change is necessary and what problems it addresses._ + +- **Issue link**: (optional) _Link the relevant issue number or GitHub Issue link if applicable (e.g., Closes #123)._ + +--- + +## Type of Change + +_Indicate the type of change by choosing one (or more) of the following:_ + +- ๐Ÿ› ๏ธ Bug fix +- โœจ New feature +- โš ๏ธ Breaking change +- ๐Ÿ”„ Refactor +- ๐Ÿ“ Documentation update +- ๐Ÿงช Tests + +--- + +## Testing + +_Describe briefly how you tested your changes._ + +--- + +## Additional Notes (optional) + +_Add any additional context or information for reviewers._ + +---