branch: elpa/autothemer
commit 1bc52d721d820c6daa07eb4742a446a811813ac6
Author: jasonm23 <jason...@gmail.com>
Commit: jasonm23 <jason...@gmail.com>
Add issue templates
---
.github/ISSUE_TEMPLATE/BUG-REPORT.yml | 90 ++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 55 ++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 1 +
CONTRIBUTING.md | 6 +-
README.md | 8 ++-
5 files changed, 154 insertions(+), 6 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
new file mode 100644
index 0000000000..b05f938bc7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -0,0 +1,90 @@
+name: "🪲 Bug Report"
+description: Create a new issue for a bug.
+title: "🪲 [BUG] - <title>"
+labels: [
+ "bug"
+]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: "Description"
+ description: Please enter a short/clear description of your issue
+ placeholder: Enter a short/clear description of your issue.
+ validations:
+ required: true
+ - type: textarea
+ id: reprod
+ attributes:
+ label: "Steps to Reproduce the issue. (Issues that cannot be reproduced
will be closed.)"
+ description: Please enter accurate steps to reproduce the issue.
+ value: |
+ 1. Open foobar.rs '...'
+ 2. M-x doctor'....'
+ 3. Doctor says: What seems to be the problem? '....'
+ 4. Debugger opens with error 'void function foo-bae'
+ render: bash
+ validations:
+ required: true
+ - type: textarea
+ id: screenshot
+ attributes:
+ label: "Screenshots"
+ description: If applicable, add screenshots to help explain your
problem. (link to or drag and drop an image.)
+ value: |
+ 
+ render: bash
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: "Logs"
+ description: Please copy and paste any relevant log or debug output.
This will be automatically formatted into code, so no need for backticks.
+ render: bash
+ validations:
+ required: false
+ - type: dropdown
+ id: browsers
+ attributes:
+ label: "Emacs version"
+ description: What Emacs version are you seeing the problem on ?
+ multiple: true
+ options:
+ - 26.1
+ - 26.2
+ - 26.3
+ - 27.1
+ - 27.2
+ - 28.1
+ - snapshot
+ validations:
+ required: false
+ - type: dropdown
+ id: display
+ attributes:
+ label: "Emacs running on GUI, Terminal or Daemon?"
+ description: How was Emacs being run? GUI, Terminal or Daemon?
+ multiple: true
+ options:
+ - "GUI"
+ - "Terminal COLORTERM=truecolor"
+ - "Terminal TERM=xterm256colors"
+ - "Terminal other (tell us about it in the description.)"
+ - "Daemon"
+ validations:
+ required: false - type: dropdown
+ id: os
+ attributes:
+ label: "OS"
+ description: What is the impacted environment ?
+ multiple: true
+ options:
+ - Windows
+ - Linux
+ - Mac
+ - Solaris
+ - AiX
+ - HP/UX
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
new file mode 100644
index 0000000000..0e179cc4a2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -0,0 +1,55 @@
+name: "🐣 Feature Request"
+description: Create a new issue for a new feature request
+title: "🐣 [REQUEST] - <title>"
+labels: [
+ "question"
+]
+body:
+ - type: textarea
+ id: implementation_pr
+ attributes:
+ label: "Implementation PR"
+ description: Pull request used
+ placeholder: "#Pull Request ID"
+ validations:
+ required: false
+ - type: textarea
+ id: reference_issues
+ attributes:
+ label: "Reference Issues"
+ description: Common issues
+ placeholder: "#Issues IDs"
+ validations:
+ required: false
+ - type: textarea
+ id: summary
+ attributes:
+ label: "Summary"
+ description: Provide a brief explanation of the feature
+ placeholder: Describe in a few lines your feature request
+ validations:
+ required: true
+ - type: textarea
+ id: basic_example
+ attributes:
+ label: "Basic Example"
+ description: Indicate here some basic examples of your feature. If the
feature exists in another product, this is a good place to mention and link to
it.
+ placeholder: A few specific words about your feature request.
+ validations:
+ required: true
+ - type: textarea
+ id: drawbacks
+ attributes:
+ label: "Drawbacks"
+ description: What are the drawbacks/impacts of your feature request ?
+ placeholder: Identify the drawbacks and impacts while being neutral on
your feature request
+ validations:
+ required: true
+ - type: textarea
+ id: unresolved_question
+ attributes:
+ label: "Unresolved questions"
+ description: What questions still remain unresolved ?
+ placeholder: Any unresolved issues?
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..3ba13e0cec
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 90b64bb8c1..dab95f0cbf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,21 +5,21 @@ Welcome to Emacs AutoThemer. You can contribute to the
project in the following
- **Bug reports:** One liner reports are difficult to understand and review.
- Follow the bug reporting issue template and provide clear, concise
descriptions and steps to reproduce the bug.
- Ensure that you have searched the existing issues to avoid duplicates.
- - Maintainers may close unclear issues that lack enough information to
reproduce a bug. [Report a bug here](https://github.com/issues).
+ - Maintainers may close unclear issues that lack enough information to
reproduce a bug. [Report a bug
here](https://github.com/jasonm23/autothemer/issues/new/choose).
- Maintainers WILL close issues if they cannot be reliably and repeatedly
reproduced, without loading your config.
- **Feature suggestions:** If you feel there is a nice enhancement or feature
that can benefit many users, please open a feature request issue.
- Ensure that you have searched the existing issues to avoid duplicates.
- What makes sense for the project, what suits its scope and goals, and
its future direction are at the discretion of the maintainers who put in the
time, effort, and energy in building and maintaining the project for free.
Please be respectful of this and keep discussions friendly and fruitful.
- It is the responsibility of the requester to clearly explain and
justify why a change is warranted. It is not the responsibility of the
maintainers to coax this information out of a requester. So, please post well
researched, well thought out, and detailed feature requests saving everyone
time.
- - Maintainers may close unclear feature requests that lack enough
information. [Suggest a feature
here](https://github.com/jasonm23/autothemer/issues).
+ - Maintainers may close unclear feature requests that lack enough
information. [Suggest a feature
here](https://github.com/jasonm23/autothemer/issues/new/choose).
- **Pull requests**
This is a tricky one for many reasons. A PR, be it a new feature or a small
enhancement, has to make sense to the project's overall scope, goals, and
technical aspects. The quality, style, and conventions of the code have to
conform to that of the project's. Performance, usability, stability and other
kinds of impacts of a PR should be well understood.
This makes reviewing PRs a difficult and time consuming task. The bigger a
PR, the more difficult it is to understand. Reviewing a PR in detail, engaging
in back and forth discussions to improve it, and deciding that it is meaningful
and safe to merge can often require more time and effort than what has gone
into creating a PR. Thus, ultimately, whether a PR gets accepted or not, for
whatever reason, is at the discretion of the maintainers. Please be respectful
of the fact that maintai [...]
- To keep the process smooth **send small PRs:** Whenever possible, send small
PRs with well defined scopes. The smaller the PR, the easier it is to review
and test. Bundling multiple features into a single PR is highly discouraged.
+ To keep the process smooth **send small PRs:** Whenever possible, send small
PRs with well defined scopes. The smaller the PR, the easier it is to review
and test. Bundling multiple features into a single PR is highly discouraged.
- **Be respectful**
Remember, most FOSS projects are fruits of love and labour of maintainers
who share them with the world for free with no expectations of any returns.
Free as in freedom, and free as in beer too. Really, *some people just want to
watch the world turn*.
diff --git a/README.md b/README.md
index 49eeb0f437..59eaf548b6 100644
--- a/README.md
+++ b/README.md
@@ -168,7 +168,7 @@ affected.
- `:slant`
- `:style`
-(NOTE: there may be others I have missed. Please open an issue if you find
+(NOTE: there may be others I have missed. Please open an [issue] if you find
another attribute that needs quoting.)
### Body / Evaluated Forms
@@ -504,8 +504,9 @@ Make sure you eval all the theme's elisp files before
enabling the theme.)
-
[emacsfodder/Cyanometric](https://github.com/emacsfodder/emacs-theme-cyanometric)
-
[emacsfodder/Vegetative](https://github.com/emacsfodder/emacs-theme-vegetative)
-If you are creating themes with Autothemer, please let us know, you can add
the theme info to
-README and open a pull request.
+If you are creating themes with Autothemer, please let us know, you can add the
+theme info to README and open a pull request. If you haven't released it as a
+package, via a common source, open an [issue], we can help.
### Contributing
@@ -516,3 +517,4 @@ See [CONTRIBUTING](CONTRIBUTING.md)
See [LICENCE](LICENCE)
[Autothemer]: https://github.com/jasonm23/autothemer
+[issue]: https://github.com/jasonm23/autothemer/issues/new/choose
