Skip to content

Commit

Permalink
Improve issue templates
Browse files Browse the repository at this point in the history
- Use same multi-lined comment convention
- Highlight that "additional information" in a bug report is optional
- Remove recommendation for pasting script in a bug report as it's too long
- Rename feature request issue file to follow same naming convention
- Document also creating a issue as a way to extend scripts
- Add reproduction steps in script bug reports
- Use names instead of commands in heading
  • Loading branch information
undergroundwires committed Aug 22, 2021
1 parent 487001a commit f2935e4
Show file tree
Hide file tree
Showing 6 changed files with 152 additions and 45 deletions.
32 changes: 26 additions & 6 deletions .github/ISSUE_TEMPLATE/1-bug-report-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ Please fill in as much of the template below as you're able.
As a small open source project with small community, it can sometimes take a long time for issues to be addressed so please be patient.
-->

### Describe the bug
### Description

<!-- A clear and concise description of what the bug is. -->
<!--
A clear and concise description of what the bug is.
-->

### OS

Expand All @@ -23,14 +25,32 @@ On Windows you can find it using "Start button" > "Settings" > "System" > "About
On macOS you can find it using "Apple menu (top left corner)" > "About This Mac".
-->

### Screenshots
### Reproduction steps

<!-- If applicable, add screenshots to help explain your problem. -->
<!--
How can the bug be recreated?
It's the most important information in the bug report. Bugs that cannot be reproduced cannot be fixed and verified.
E.g.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->

### Scripts

<!-- Which scripts did you execute? If applicable, please paste the executed scripts or attach the generated privacy.sexy file . -->
<!--
If applicable, please attach the generated privacy.sexy file instead of copy pasting which becomes too long.
-->

### Screenshots

<!--
If applicable, add screenshots to help explain your problem.
-->

### Additional information

<!-- Add any other context about the problem here. -->
<!--
If applicable, add any other context about the problem here.
-->
17 changes: 10 additions & 7 deletions .github/ISSUE_TEMPLATE/2-bug-report-generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ Please fill in as much of the template below as you're able.
As a small open source project with small community, it can sometimes take a long time for issues to be addressed so please be patient.
-->

### Describe the bug
### Description

<!-- A clear and concise description of what the bug is. -->
<!--
A clear and concise description of what the bug is.
-->

### To Reproduce
### Reproduction steps

<!--
<!--
It's the most important information in the bug report. Bugs that cannot be reproduced cannot be fixed and verified.
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
Expand All @@ -41,12 +44,12 @@ If applicable, add screenshots to help explain your problem.

<!--
If applicable, mention how you were using privacy.sexy when the bug was encountered:
- Web (on Desktop or mobile?)
- Or desktop (Windows, macOS or Linux?)
- Web (on Desktop or mobile?)
- Or desktop (Windows, macOS or Linux?)
-->

### Additional context

<!--
Add any other context about the problem here.
If applicable, add any other context about the problem here.
-->
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/3-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Feature request
about: Suggest an idea for privacy.sexy
labels: enhancement
---

<!--
Thank you for suggesting an idea to improve privacy better 🤗.
Please fill in as much of the template below as you're able.
-->

### Problem description

<!--
What are we trying to solve?
Please add a clear and concise description of the problem you are seeking to solve with this feature request.
E.g. I'm always frustrated when [...]
-->

### Proposed solution

<!--
Describe the solution you'd like in a clear and concise manner.
-->

### Alternatives considered

<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

### Additional information

<!--
If applicable, add any other context or screenshots about the feature request here.
-->
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/3-feature_request.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/4-new-script-suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
name: New script suggestion
about: Suggest a new script for privacy.sexy
labels: enhancement
---

<!--
Thank you for suggesting an script to make privacy better. 🤗
Please fill in as much of the template below as you're able.
You could alternatively send a PR directly (see CONTRIBUTING.md).
-->

### OS

<!--
Which OS will the new script configure?
Either "Windows" or "macOS".
-->

### Name

<!--
The name of the script.
It should start with an imperative noun such as "disable", "turn off" , "clear"...
E.g. "Disable webcam telemetry"
-->

### Script code

<!--
Code that will be executed when script is selected.
Try to keep it as simple and backwards-compatible as possible.
Allowed languages:
- macOS: bash (sh)
- Windows: PowerShell (ps1) or batchfile
- 💡 Prioritize the one that's simpler, batchfile if similar.
-->

### Revert code

<!--
If applicable, add code that will revert the script code to its original (OS default) state.
It may require additional time, but it's much appreciated by the community.
Leave blank if the script is nonreversible (e.g. when clearing data without backup).
-->

### Suggested category

<!--
If applicable, suggest one more multiple suitable parent category of script.
A category is the item where the script will be presented under.
Most likely there already is a category for the script, so check the existing categories.
If you're unsure, leave blank and maintainer(s) will choose one.
-->

### Suggested recommendation level

<!--
If applicable, suggest recommending the script or not recommending at all.
A script should be only recommended if it'll be safe for your grandmother to run.
So you have three options here:
STANDARD: Non-breaking scripts that does not limit any functionality.
STRICT: Scripts that can break certain functionality but not intrusive to common daily OS usage.
NONE: Script is not recommended for newbies at all, only those who knows what's going on should select it.
If you're unsure, leave blank and maintainer(s) will choose one.
-->

### Additional documentation/references

<!--
If applicable, refer to documentation that should show up on the script description.
Sources (URLs) should be as high quality as possible e.g. vendor documentation is favored over user forums.
-->
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@

## Extend scripts

1. Fork the repository
2. Add more scripts in respective script collection in [collections](src/application/collections/) folder.
- 📖 If you're unsure about the syntax you can refer to the [collection files | documentation](docs/collection-files.md).
- 🙏 For any new script, please add `revertCode` and `docs` values if possible.
3. Send a pull request 👌
- You can either [create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose)
- Or send a PR:
1. Fork the repository
2. Add more scripts in respective script collection in [collections](src/application/collections/) folder.
- 📖 If you're unsure about the syntax you can refer to the [collection files | documentation](docs/collection-files.md).
- 🙏 For any new script, please add `revertCode` and `docs` values if possible.
3. Send a pull request 👌

## Commands

Expand Down

0 comments on commit f2935e4

Please sign in to comment.