Add GitHub templates

pull/150/head
Tim Byrne 4 years ago
parent b443bbede2
commit 19c6eb6009
No known key found for this signature in database
GPG Key ID: 14DB4FC2465A4B12
  1. 7
      .github/ISSUE_TEMPLATE.md
  2. 68
      .github/ISSUE_TEMPLATE/BUG_REPORT.md
  3. 29
      .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
  4. 23
      .github/ISSUE_TEMPLATE/OTHER.md
  5. 36
      .github/ISSUE_TEMPLATE/SUPPORT.md
  6. 34
      .github/PULL_REQUEST_TEMPLATE.md

@ -0,0 +1,7 @@
<!--
Before submitting, please search open and closed issues at
https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
If you have found a security vulnerability, do NOT open an issue.
Email yadm@yadm.io instead.
-->

@ -0,0 +1,68 @@
---
name: Bug report
about: Create a report to help improve yadm
title: ''
labels: bug
assignees: ''
---
<!--
Before submitting, please search open and closed issues at
https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
If you have found a security vulnerability, do NOT open an issue.
Email yadm@yadm.io instead.
-->
### Describe the bug
[A clear and concise description of what the bug is.]
### To reproduce
Can this be reproduced with the yadm/testbed docker image: [Yes/No]
<!--
Consider trying to reproduce the bug inside a docker container using the
yadm/testbed docker image. https://hub.docker.com/r/yadm/testbed
The easiest way to start this container, is to clone the TheLocehiliosan/yadm
repo, and use the "scripthost" make target. For example:
$ git clone https://github.com/TheLocehiliosan/yadm.git
$ cd yadm
$ make scripthost version=1.11.0
Starting scripthost version="1.11.0" (recording script)
root@scripthost:~# ### run commands which
root@scripthost:~# ### demonstrate the problem
root@scripthost:~# ### a succinct set of commands is best
root@scripthost:~# exit
logout
Script saved to script.gz
$
A script like this can be useful to developers to make a repeatable test for the
problem. You can attach a script.gz file to an issue.
https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
-->
Steps to reproduce the behavior:
1. Run command '....'
2. Run command '....'
3. Run command '....'
4. See error
### Expected behavior
[A clear and concise description of what you expected to happen.]
### Environment
- Operating system: [Ubuntu 18.04, yadm/testbed, etc.]
- Version yadm: [found via `yadm version`]
- Version Git: [found via `git --version`]
### Additional context
[Add any other context about the problem here.]

@ -0,0 +1,29 @@
---
name: Feature request
about: Suggest an idea for yadm
title: ''
labels: feature
assignees: ''
---
<!--
Before submitting, please search open and closed issues at
https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
-->
### Is your feature request related to a problem? Please describe.
[A clear and concise description of what the problem is. Ex. I'm always frustrated when ...]
### Describe the solution you'd like
[A clear and concise description of what you want to happen.]
### Describe alternatives you've considered
[A clear and concise description of any alternative solutions or features you've
considered. For example, have you considered using yadm "hooks" as a solution?]
### Additional context
[Add any other context or screenshots about the feature request here.]

@ -0,0 +1,23 @@
---
name: Other issue
about: Report issues with documentation, packaging, or something else
title: ''
labels: ''
assignees: ''
---
<!--
Before submitting, please search open and closed issues at
https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
-->
### This issue is about
* [ ] Man pages or command-line usage
* [ ] Website documentation
* [ ] Packaging
* [ ] Other
### Describe the issue
[A clear and concise description of the issue.]

@ -0,0 +1,36 @@
---
name: Support
about: Get help using yadm
title: ''
labels: 'question'
assignees: ''
---
<!--
Before submitting, please search open and closed issues at
https://github.com/TheLocehiliosan/yadm/issues to avoid duplication.
Please also consult:
* The FAQ: https://yadm.io/docs/faq
* The manual: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md
-->
### This question is about
* [ ] Installation
* [ ] Initializing / Cloning
* [ ] Alternate files
* [ ] Jinja templates
* [ ] Encryption
* [ ] Bootstrap
* [ ] Hooks
* [ ] Other
### Describe your question
<!--
Consider including:
* the commands you've run, and the output produced
* links to any public repo/branch involved
-->
[A clear and concise description of the question.]

@ -0,0 +1,34 @@
### What does this PR do?
[A clear and concise description of what this pull request accomplishes.]
### What issues does this PR fix or reference?
<!--
Be sure to preface the issue/PR numbers with a "#".
-->
[A list of related issues / pull requests.]
### Previous Behavior
[Describe the existing behavior.]
### New Behavior
[Describe the behavior, after this PR is applied.]
### Have [tests][1] been written for this change?
[Yes / No]
### Have these commits been [signed with GnuPG][2]?
[Yes / No]
---
Please review [yadm's Contributing Guide][3] for best practices.
[1]: https://github.com/TheLocehiliosan/yadm/blob/master/.github/CONTRIBUTING.md#test-conventions
[2]: https://help.github.com/en/articles/signing-commits
[3]: https://github.com/TheLocehiliosan/yadm/blob/master/.github/CONTRIBUTING.md
Loading…
Cancel
Save