From f7a3cee25abf15a80812e6374a4888462471a1d9 Mon Sep 17 00:00:00 2001 From: Jonathan White Date: Thu, 16 Apr 2020 09:27:54 -0400 Subject: [PATCH] Update Issue and Pull Request templates --- .github/ISSUE_TEMPLATE/bug-report.md | 40 +++++++---------- .github/ISSUE_TEMPLATE/feature-request.md | 15 ++----- .../release-preview-bug-report.md | 44 +++++++------------ .github/PULL_REQUEST_TEMPLATE.md | 33 ++++---------- 4 files changed, 45 insertions(+), 87 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 4b6d16c6c..a4a3ae2cd 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -6,44 +6,34 @@ labels: bug assignees: '' --- - -[TIP]: # ( Provide a general summary of the issue in the title above ^^ ) +## Overview [TIP]: # ( DO NOT include screenshots of your actual database! ) +[NOTE]: # ( Give a BRIEF summary about your problem ) + + +## Steps to Reproduce +[NOTE]: # ( Provide a simple set of steps to reproduce this bug. ) +1. +2. +3. ## Expected Behavior [NOTE]: # ( Tell us what you expected to happen ) -## Current Behavior +## Actual Behavior [NOTE]: # ( Tell us what actually happens ) -## Possible Solution -[NOTE]: # ( Not required, but suggest a fix/reason for the bug ) - - -## Steps to Reproduce -[NOTE]: # ( Provide a link to a live example, or an unambiguous set of steps to ) -[NOTE]: # ( reproduce this bug. Include code to reproduce, if relevant ) -1. -2. -3. - ## Context -[NOTE]: # ( How has this issue affected you? What unique circumstances do you have? ) +[NOTE]: # ( Give us any additional information you may have. ) -## Debug Info [NOTE]: # ( Paste debug info from Help → About here ) KeePassXC - VERSION Revision: REVISION -Libraries: -- LIBS - -Operating system: OS -CPU architecture: ARCH -Kernel: KERNEL - -Enabled extensions: -- EXTENSIONS +[NOTE]: # ( Pick choices based on your environment ) +Operating System: Windows/Linux/macOS +Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon +Windowing System: X11/Wayland \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 90c28c42b..d213b4fa3 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,25 +1,18 @@ --- name: Feature Request -about: tell us about a new capability you want to see +about: tell us about a new feature you want title: labels: new feature assignees: '' --- - -[TIP]: # ( Provide a general summary of the feature in the title above ^^ ) -[TIP]: # ( DO NOT include screenshots of your actual database! ) - ## Summary +[TIP]: # ( DO NOT include screenshots of your actual database! ) [NOTE]: # ( Provide a brief overview of what the new feature is all about ) -## Desired Behavior -[NOTE]: # ( Tell us how the new feature should work, be specific ) - - -## Possible Solution -[NOTE]: # ( Not required, but suggest ideas on how to implement the addition or change ) +## Examples +[NOTE]: # ( Show us a picture or mock-up of your proposal ) ## Context diff --git a/.github/ISSUE_TEMPLATE/release-preview-bug-report.md b/.github/ISSUE_TEMPLATE/release-preview-bug-report.md index a22d1fa69..b2fbf65ff 100644 --- a/.github/ISSUE_TEMPLATE/release-preview-bug-report.md +++ b/.github/ISSUE_TEMPLATE/release-preview-bug-report.md @@ -1,49 +1,39 @@ --- name: Release Preview Bug report -about: report a bug with a release preview (e.g., 2.4.0-beta1) -title: "[PRE-RELEASE] " +about: report a bug with a release preview (e.g., 2.6.0-beta1) +title: labels: PRE-RELEASE BUG assignees: droidmonkey --- - -[TIP]: # ( Provide a general summary of the issue in the title above ^^ ) +## Overview [TIP]: # ( DO NOT include screenshots of your actual database! ) +[NOTE]: # ( Give a BRIEF summary about your problem ) + + +## Steps to Reproduce +[NOTE]: # ( Provide a simple set of steps to reproduce this bug. ) +1. +2. +3. ## Expected Behavior [NOTE]: # ( Tell us what you expected to happen ) -## Current Behavior +## Actual Behavior [NOTE]: # ( Tell us what actually happens ) -## Possible Solution -[NOTE]: # ( Not required, but suggest a fix/reason for the bug ) - - -## Steps to Reproduce -[NOTE]: # ( Provide a link to a live example, or an unambiguous set of steps to ) -[NOTE]: # ( reproduce this bug. Include code to reproduce, if relevant ) -1. -2. -3. - ## Context -[NOTE]: # ( How has this issue affected you? What unique circumstances do you have? ) +[NOTE]: # ( Give us any additional information you may have. ) -## Debug Info [NOTE]: # ( Paste debug info from Help → About here ) KeePassXC - VERSION Revision: REVISION -Libraries: -- LIBS - -Operating system: OS -CPU architecture: ARCH -Kernel: KERNEL - -Enabled extensions: -- EXTENSIONS +[NOTE]: # ( Pick choices based on your environment ) +Operating System: Windows/Linux/macOS +Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon +Windowing System: X11/Wayland \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 89b548554..e75bbcd60 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,6 @@ -[TIP]: # ( Provide a general summary of your changes in the title above ^^ ) - -## Type of change -[NOTE]: # ( Please remove all lines which don't apply. ) -- ✅ Bug fix (non-breaking change which fixes an issue) -- ✅ Refactor (significant modification to existing code) -- ✅ New feature (non-breaking change which adds functionality) -- ✅ Breaking change (fix or feature that would cause existing functionality to change) -- ✅ Documentation (non-code change) - -## Description and Context [NOTE]: # ( Describe your changes in detail, why is this change required? ) -[NOTE]: # ( Describe the context of your change. Explain large code modifications. ) -[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" as necessary ) +[NOTE]: # ( Explain large or complex code modifications. ) +[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" ) ## Screenshots @@ -23,14 +12,10 @@ [TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! ) -## Checklist: -[NOTE]: # ( Please go over all the following points. ) -[NOTE]: # ( Again, remove any lines which don't apply. ) -[NOTE]: # ( Pull Requests that don't fulfill all [REQUIRED] requisites are likely ) -[NOTE]: # ( to be sent back to you for correction or will be rejected. ) -- ✅ I have read the **CONTRIBUTING** document. **[REQUIRED]** -- ✅ My code follows the code style of this project. **[REQUIRED]** -- ✅ All new and existing tests passed. **[REQUIRED]** -- ✅ I have compiled and verified my code with `-DWITH_ASAN=ON`. **[REQUIRED]** -- ✅ My change requires a change to the documentation, and I have updated it accordingly. -- ✅ I have added tests to cover my changes. +## Type of change +[NOTE]: # ( Please remove all lines which don't apply. ) +- ✅ Bug fix (non-breaking change that fixes an issue) +- ✅ New feature (change that adds functionality) +- ✅ Breaking change (causes existing functionality to change) +- ✅ Refactor (significant modification to existing code) +- ✅ Documentation (non-code change)