From 48d29273af0044b2f873e743a7b8de67f7dd8ae0 Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Mon, 8 Apr 2019 16:34:08 -0700 Subject: [PATCH] adding pr and issue templates --- KOSU_ISSUE_TEMPLATE.md | 45 ++++++++++++++++++++++++++++++++++++++++++ KOSU_PR_TEMPLATE.md | 43 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 KOSU_ISSUE_TEMPLATE.md create mode 100644 KOSU_PR_TEMPLATE.md diff --git a/KOSU_ISSUE_TEMPLATE.md b/KOSU_ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e68b6ecb --- /dev/null +++ b/KOSU_ISSUE_TEMPLATE.md @@ -0,0 +1,45 @@ +_Base issue template for Kosu projects. Modify as needed._ + +# Overview + +_Summarize the issue. Why are you here?_ + +# Description + +_Provide additional details about the bug/issue. Include the two sections below for bugs._ + +## Expected behavior + +_What should happen?_ + +## Current behavior + +_What is happening?_ + +## Steps to reproduce + +_In as much detail as possible, describe how to re-create the bug._ + +``` +1. +2. +3. +... +``` + +## Environment + +_Describe environment, incl. package name/version, OS version, runtime, etc._ + +# Notes + +_Space for additional comments, ideas about how to fix, what the cause is, etc._ + +# Action items + +_If there are any, include action items here in check boxes. Example shown below._ + +- [ ] Verify this is incorrect behavior +- [ ] Isolate and determine cause +- [ ] Assign team member to fix +- [ ] Move discussion to PR \ No newline at end of file diff --git a/KOSU_PR_TEMPLATE.md b/KOSU_PR_TEMPLATE.md new file mode 100644 index 00000000..e5bb2d38 --- /dev/null +++ b/KOSU_PR_TEMPLATE.md @@ -0,0 +1,43 @@ +_Pull request template for Kosu projects. Modify minimally as needed on a project basis._ + +# Overview + +_Provide a brief summary of the PR and it's purpose. May include plans if a [WIP]._ + +# Description + +_Describe in detail what changes you plan to make in this section and sub-sections_ + +## Relevant links + +_Link any supporting material to help people understand your PR. This may inclue links to discussions that took place in an issue or other forum, or links to the problematic code you plan to change._ + +_This section may be omitted as necessary._ + +## Testing instructions + +_Provide directors for reviewers and others to test your changes. What should happen when your changes are finalized?_ + +## Types of changes + +_Check one of the boxes below, and add additional information as necessary._ + +- [ ] Bug fix (non-breaking change which fixes an issue) + +- [ ] New feature (non-breaking change which adds functionality, compatible with previous versions) + +- [ ] Breaking change (feature or bug-fix that changes behavior and requires a major/minor version bump) + +# Notes + +_Include any additional comments, thoughts, questions, or discussion items here that don't fit elsewhere. Omit as needed._ + +# Status + +_Use this section to keep reviews and maintainers up-to-date with the status and progress of your PR. Check any boxes that are already complete upon creation of the PR, and update whenever necessary. Don't hesitate to ask for help._ + +- [ ] Prefix PR title with `[WIP]` if necessary (changes not yet made). +- [ ] Add tests to cover changes as needed. +- [ ] Update documentation as needed. +- [ ] Add new entries to the relevant CHANGELOG file(s). +- [ ] Ready for review \ No newline at end of file