Update Issue and Pull Request templates

This commit is contained in:
Jonathan White 2020-04-16 09:27:54 -04:00
parent 5795051477
commit f7a3cee25a
4 changed files with 45 additions and 87 deletions

View File

@ -6,44 +6,34 @@ labels: bug
assignees: '' assignees: ''
--- ---
## Overview
[TIP]: # ( Provide a general summary of the issue in the title above ^^ )
[TIP]: # ( DO NOT include screenshots of your actual database! ) [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 ## Expected Behavior
[NOTE]: # ( Tell us what you expected to happen ) [NOTE]: # ( Tell us what you expected to happen )
## Current Behavior ## Actual Behavior
[NOTE]: # ( Tell us what actually happens ) [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 ## 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 ) [NOTE]: # ( Paste debug info from Help → About here )
KeePassXC - VERSION KeePassXC - VERSION
Revision: REVISION Revision: REVISION
Libraries: [NOTE]: # ( Pick choices based on your environment )
- LIBS Operating System: Windows/Linux/macOS
Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon
Operating system: OS Windowing System: X11/Wayland
CPU architecture: ARCH
Kernel: KERNEL
Enabled extensions:
- EXTENSIONS

View File

@ -1,25 +1,18 @@
--- ---
name: Feature Request name: Feature Request
about: tell us about a new capability you want to see about: tell us about a new feature you want
title: title:
labels: new feature labels: new feature
assignees: '' assignees: ''
--- ---
[TIP]: # ( Provide a general summary of the feature in the title above ^^ )
[TIP]: # ( DO NOT include screenshots of your actual database! )
## Summary ## Summary
[TIP]: # ( DO NOT include screenshots of your actual database! )
[NOTE]: # ( Provide a brief overview of what the new feature is all about ) [NOTE]: # ( Provide a brief overview of what the new feature is all about )
## Desired Behavior ## Examples
[NOTE]: # ( Tell us how the new feature should work, be specific ) [NOTE]: # ( Show us a picture or mock-up of your proposal )
## Possible Solution
[NOTE]: # ( Not required, but suggest ideas on how to implement the addition or change )
## Context ## Context

View File

@ -1,49 +1,39 @@
--- ---
name: Release Preview Bug report name: Release Preview Bug report
about: report a bug with a release preview (e.g., 2.4.0-beta1) about: report a bug with a release preview (e.g., 2.6.0-beta1)
title: "[PRE-RELEASE] " title:
labels: PRE-RELEASE BUG labels: PRE-RELEASE BUG
assignees: droidmonkey assignees: droidmonkey
--- ---
## Overview
[TIP]: # ( Provide a general summary of the issue in the title above ^^ )
[TIP]: # ( DO NOT include screenshots of your actual database! ) [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 ## Expected Behavior
[NOTE]: # ( Tell us what you expected to happen ) [NOTE]: # ( Tell us what you expected to happen )
## Current Behavior ## Actual Behavior
[NOTE]: # ( Tell us what actually happens ) [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 ## 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 ) [NOTE]: # ( Paste debug info from Help → About here )
KeePassXC - VERSION KeePassXC - VERSION
Revision: REVISION Revision: REVISION
Libraries: [NOTE]: # ( Pick choices based on your environment )
- LIBS Operating System: Windows/Linux/macOS
Desktop Env: Gnome/KDE/XFCE/Mate/Cinnamon
Operating system: OS Windowing System: X11/Wayland
CPU architecture: ARCH
Kernel: KERNEL
Enabled extensions:
- EXTENSIONS

View File

@ -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 your changes in detail, why is this change required? )
[NOTE]: # ( Describe the context of your change. Explain large code modifications. ) [NOTE]: # ( Explain large or complex code modifications. )
[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" as necessary ) [NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" )
## Screenshots ## Screenshots
@ -23,14 +12,10 @@
[TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! ) [TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! )
## Checklist: ## Type of change
[NOTE]: # ( Please go over all the following points. ) [NOTE]: # ( Please remove all lines which don't apply. )
[NOTE]: # ( Again, remove any lines which don't apply. ) - ✅ Bug fix (non-breaking change that fixes an issue)
[NOTE]: # ( Pull Requests that don't fulfill all [REQUIRED] requisites are likely ) - ✅ New feature (change that adds functionality)
[NOTE]: # ( to be sent back to you for correction or will be rejected. ) - ✅ Breaking change (causes existing functionality to change)
- ✅ I have read the **CONTRIBUTING** document. **[REQUIRED]** - ✅ Refactor (significant modification to existing code)
- ✅ My code follows the code style of this project. **[REQUIRED]** - ✅ Documentation (non-code change)
- ✅ 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.