Skip to content

Commit

Permalink
update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
@claustromaniac
claustromaniac committed Jun 27, 2019
1 parent 408a992 commit f85eb9d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/tools.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
name: Tools
about: Report issues with the updaters, troubleshooter, or any other tools.
about: Report issues with the updaters, the troubleshooter, or any other tools.
title: ''
labels: ''
assignees: ''

---

<!--
Make sure to specify:
Please specify:
- the name of the file (i.e. updater.bat, updater.sh)
- the OS where you used the tool (if applicable)
- steps to reproduce the issue
- expected result
- actual result
- expected result
Blank out this field before typing, or start typing after the next line.
-->
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/troubleshooting-help.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Troubleshooting help
about: Ask for help troubleshooting issues with user.js
about: Ask for help to solve problems with user.js
title: ''
labels: ''
assignees: ''

---

<!--
Before you ask for help...
Before you proceed...
- Keep reading this. Seriously.
- Note that we do not support forks (i.e. IceCat, Pale Moon, WaterFox, etc).
- Make sure you searched for the setup tags in user.js.
Expand All @@ -32,4 +32,6 @@ If you still need help, help us help you by providing relevant information:
- actual result
- expected result
- anything else you deem worth mentioning
Blank out this field before typing, or start typing after the next line.
-->
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/user-js.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: User.js
name: user.js
about: Suggest changes to user.js
title: ''
labels: ''
Expand All @@ -9,5 +9,8 @@ assignees: ''

<!--
We value feedback in general, but we value feedback from informed users more. There is no need for you to be an expert to participate (most of us aren't), but we hope that you at least understand our decisions before questioning them. We discuss all changes openly, and we do not make changes lightly. So, if you don't understand why we decided to add/remove/change a certain pref, search the repo. The answer is most certainly here.
If some change we made took you by surprise (in the wrong way), remember that keeping track of changes is your responsibility. Watch the repo, read the changelogs, compare revisions as you update your copy of user.js, or use any other method you prefer.
Blank out this field before typing, or start typing after the next line.
-->

3 comments on commit f85eb9d

@claustromaniac
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👖, when you get down to tweaking these, another thing that you might want to mention in user-js.md, is that you don't want people throwing massive lists of prefs at you (#442, #542, etc).

@Thorin-Oakenpants
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 🐈 but that is so rare now, that I'd rather leave the instructions as short as possible

@claustromaniac
Copy link
Contributor Author

@claustromaniac claustromaniac commented on f85eb9d Jun 27, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine, but I think you're free to go wild here, considering we can make the templates as specific as we want. The way I wrote these templates, they're not really templates. They're more like guidelines, meant to filter out stuff. The idea is that users choose the one that seems to match their intentions more, and when they do, they get a bunch of "uh, yeah, you wanna do that? Great. But first, do this and this, and be aware that we don't want you to do this"

Also, notice my choice of words... Suggest changes to user.js. If you wanted, you could use the same strategy for more extreme scenarios, for example, you could add a separate "template" saying Demand changes to user.js in the description, that when selected by the user just says Nuh-uh, you're not entitled to demanding shit (see the license). Fuck off

Please sign in to comment.