Add issue templates

This commit is contained in:
Justin Mayer 2020-05-17 07:04:26 +02:00
commit 7c9c1c63cc
5 changed files with 116 additions and 0 deletions

40
.github/ISSUE_TEMPLATE/---bug-report.md vendored Normal file
View file

@ -0,0 +1,40 @@
---
name: "\U0001F41E Bug Report"
about: Did you find a bug?
title: ''
labels: bug
assignees: ''
---
<!--
Hi there! Thank you for discovering and submitting an issue.
Before you submit this, lets make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill them first.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] I have read the [Filing Issues](https://docs.getpelican.com/en/latest/contribute.html#filing-issues) and subsequent “How to Get Help” sections of the documentation.
- [ ] I have searched the [issues](https://github.com/getpelican/pelican/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
<!--
Once the above boxes are checked, if you are able to fill in the following list
with your information, it would be very helpful for maintainers.
-->
- **OS version and name**: <!-- Replace with version + name -->
- **Python version**: <!-- Replace with version -->
- **Pelican version**: <!-- Replace with version -->
- **Link to theme**: <!-- Replace with link to the theme you are using -->
- **Links to plugins**: <!-- Replace with list of links to plugins you are using -->
- **Link to your site**: <!-- If available, replace with link to your site -->
- **Link to your source**: <!-- If available, replace with link to relevant source repository -->
- **Link to a [Gist](https://gist.github.com/) with the contents of your settings file**: <!-- If your source is not accessible, put Gist link here -->
## Issue
<!--
Now feel free to write your issue. Please avoid vague phrases like “[…] doesnt work”.
Be descriptive! Thanks again 🙌 ❤️
-->

View file

@ -0,0 +1,22 @@
---
name: "\U0001F4DA Documentation"
about: Did you find errors, problems, or anything unclear in the docs (https://docs.getpelican.com/)?
title: ''
labels: docs
assignees: ''
---
<!--
Hi there! Thank you for discovering and submitting an issue with our documentation.
Before you submit this, lets make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill them first.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] I have searched the [issues](https://github.com/getpelican/pelican/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
## Issue
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->

View file

@ -0,0 +1,24 @@
---
name: "\U0001F381 Feature Request"
about: Do you have ideas for new features and improvements?
title: ''
labels: enhancement
assignees: ''
---
<!--
Hi there! Thank you for wanting to make Pelican better.
Before you submit this, lets make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill them first. The last one is optional but encouraged.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] I have searched the [issues](https://github.com/getpelican/pelican/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
- [ ] I have searched the [documentation](https://docs.getpelican.com/) and believe that my question is not covered.
- [ ] I am willing to lend a hand to help implement this feature. <!-- optional but encouraged -->
## Feature Request
<!-- Now feel free to write your idea for improvement. Thanks again 🙌 ❤️ -->

View file

@ -0,0 +1,23 @@
---
name: "\U0001F5C3 Everything Else"
about: Do you have a question/issue that does not fall into any of the other categories?
title: ''
labels: question
assignees: ''
---
<!--
Describe your question/issue here. This space is meant to be used for general questions
that are not bugs, feature requests, or documentation issues.
Before you submit this, lets make sure of a few things.
Please make sure the following boxes are ticked if they are correct.
If not, please try and fulfill them first.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] I have searched the [issues](https://github.com/getpelican/pelican/issues?q=is%3Aissue) (including closed ones) and believe that this is not a duplicate.
- [ ] I have searched the [documentation](https://docs.getpelican.com/) and believe that my question is not covered.
## Issue
<!-- Now feel free to write your issue, but please be descriptive! Thanks again 🙌 ❤️ -->

7
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,7 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: '💬 Pelican IRC Channel on Freenode'
url: https://kiwiirc.com/client/irc.freenode.net/?#pelican
about: |
Chat with the community, ask questions, and learn about best practices.