chore(config): add github templates for issues and pull requests
Signed-off-by: Patrick Kollitsch <patrick@davids-neighbour.com>
This commit is contained in:
parent
3c3478addf
commit
7c5c9c307b
40
.github/ISSUE_TEMPLATE/bugs.md
vendored
Normal file
40
.github/ISSUE_TEMPLATE/bugs.md
vendored
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
name: Report a bug
|
||||||
|
about: Use this template to report a bug.
|
||||||
|
title: "bug: ###"
|
||||||
|
labels: status:unconfirmed
|
||||||
|
assignees: davidsneighbour
|
||||||
|
---
|
||||||
|
|
||||||
|
Issue tracker is **ONLY** used for reporting bugs. New features should be discussed on our slack channel. Please use [stackoverflow](https://stackoverflow.com) for supporting issues.
|
||||||
|
|
||||||
|
<!--- Provide a general summary of the issue in the Title above -->
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
<!--- Tell us what should happen -->
|
||||||
|
|
||||||
|
## Current Behavior
|
||||||
|
<!--- Tell us what happens instead of the expected behavior -->
|
||||||
|
|
||||||
|
## Possible Solution
|
||||||
|
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
|
||||||
|
<!--- reproduce this bug. Include code to reproduce, if relevant -->
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
4.
|
||||||
|
|
||||||
|
## Context (Environment)
|
||||||
|
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||||
|
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
|
||||||
|
|
||||||
|
<!--- Provide a general summary of the issue in the Title above -->
|
||||||
|
|
||||||
|
## Detailed Description
|
||||||
|
<!--- Provide a detailed description of the change or addition you are proposing -->
|
||||||
|
|
||||||
|
## Possible Implementation
|
||||||
|
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
|
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Feature requests and problem solutions
|
||||||
|
url: /theNewDynamic/gohugo-theme-ananke/discussions
|
||||||
|
about: Please ask and answer questions here. Open a bug report only if you are sure it is a bug.
|
25
.github/pull_request_template.md
vendored
Normal file
25
.github/pull_request_template.md
vendored
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
|
||||||
|
|
||||||
|
*Any change needs to be discussed before proceeding. Not doing so may result in the rejection of the pull request without much notice.*
|
||||||
|
|
||||||
|
Please provide enough information so that others can review your pull request:
|
||||||
|
|
||||||
|
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
|
||||||
|
|
||||||
|
Explain the **details** for making this change. What existing problem does the pull request solve?
|
||||||
|
|
||||||
|
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
|
||||||
|
|
||||||
|
**Test plan (required)**
|
||||||
|
|
||||||
|
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
||||||
|
|
||||||
|
<!-- Make sure tests pass on both Travis and Circle CI. -->
|
||||||
|
|
||||||
|
**Code formatting**
|
||||||
|
|
||||||
|
<!-- See the simple style guide. -->
|
||||||
|
|
||||||
|
**Closing issues**
|
||||||
|
|
||||||
|
Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes.
|
Loading…
Reference in a new issue