diff --git a/.github/ISSUE_TEMPLATE/1-bug-report-scripts.md b/.github/ISSUE_TEMPLATE/1-bug-report-scripts.md index 446f7abc..a48c5c10 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report-scripts.md +++ b/.github/ISSUE_TEMPLATE/1-bug-report-scripts.md @@ -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 - + ### OS @@ -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 - + ### Scripts - + + +### Screenshots + + ### Additional information - + diff --git a/.github/ISSUE_TEMPLATE/2-bug-report-generic.md b/.github/ISSUE_TEMPLATE/2-bug-report-generic.md index 0ee00fd4..da957c8d 100644 --- a/.github/ISSUE_TEMPLATE/2-bug-report-generic.md +++ b/.github/ISSUE_TEMPLATE/2-bug-report-generic.md @@ -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 - + -### To Reproduce +### Reproduction steps - ### Additional context diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.md b/.github/ISSUE_TEMPLATE/3-feature-request.md new file mode 100644 index 00000000..99a34742 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-feature-request.md @@ -0,0 +1,36 @@ +--- +name: Feature request +about: Suggest an idea for privacy.sexy +labels: enhancement +--- + + + +### Problem description + + + +### Proposed solution + + + +### Alternatives considered + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/3-feature_request.md b/.github/ISSUE_TEMPLATE/3-feature_request.md deleted file mode 100644 index 8cfa1363..00000000 --- a/.github/ISSUE_TEMPLATE/3-feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for privacy.sexy -labels: enhancement ---- - - - -### Problem Description - - - -### Proposed solution - - - -### Alternatives considered - - - -### Additional information - - diff --git a/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md b/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md new file mode 100644 index 00000000..a4a368f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md @@ -0,0 +1,73 @@ +--- +name: New script suggestion +about: Suggest a new script for privacy.sexy +labels: enhancement +--- + + + +### OS + + + +### Name + + + +### Script code + + + +### Revert code + + + +### Suggested category + + + +### Suggested recommendation level + + + +### Additional documentation/references + + diff --git a/README.md b/README.md index 1a7d30d7..9e227bb5 100644 --- a/README.md +++ b/README.md @@ -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