[undergroundwires](https://undergroundwires.dev)
+ + --- diff --git a/.github/ISSUE_TEMPLATE/2-bug-report-general.yaml b/.github/ISSUE_TEMPLATE/2-bug-report-general.yaml new file mode 100644 index 000000000..4ceff362b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report-general.yaml @@ -0,0 +1,104 @@ +name: "Bug Report: General" +description: 🐛 Report general issues to enhance privacy.sexy +labels: [ 'bug' ] +title: '[Bug]: ' +body: + - + type: markdown + attributes: + value: |- + Thank you for contributing to privacy.sexy and guiding our direction! 🌟 + Please complete as much of the form below as possible. + Your feedback is valuable, even if you can't provide all details. + - + type: textarea + attributes: + label: Description + description: Provide a clear and concise description of the issue. + placeholder: >- + For example: "I cannot select any scripts." + validations: + required: true + - + type: textarea + attributes: + label: Reproduction steps + description: |- + This is the most important information in the bug report. + Bugs that cannot be reproduced cannot be fixed or verified. + placeholder: |- + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - + type: textarea + attributes: + label: Expected behavior + description: Describe what you expected to happen when the error occurred. + placeholder: >- + For example: "I expected the settings menu to open smoothly without crashing.". + validations: + required: true + - + type: textarea + attributes: + label: Screenshots + description: |- + If applicable, add screenshots to help explain your problem. + + > **💡 Tip:** You can attach screenshots by clicking this area to highlight it and then pasting them or dragging files in. + placeholder: >- + Attach screenshots here or link to image hosting. + validations: + required: false + - + type: textarea + attributes: + label: privacy.sexy environment details + description: |- + If applicable, mention how you were using privacy.sexy when the bug occurred: + + - Web (on which operating system and browser?) + - Or desktop (Windows, macOS, or Linux?) + placeholder: >- + For example: "The web version on Edge browser on Windows 11 23H2." + validations: + required: false + - + type: textarea + attributes: + label: Additional context + description: |- + If applicable, add any other context about the problem here. + + Helpful information includes: + + - Application logs (desktop version only), see: [how to find application logs](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md#logging). + - Terminal output + - Proposed solutions + - Other related context such as related issues, software behavior, etc. + + > **💡 Tip:** You can attach log files by dragging them into this area. + placeholder: >- + For example: "Here are the logs I get from the privacy.sexy 0.13.2 desktop application: ..." + validations: + required: false + - + type: markdown + attributes: + value: |- + --- + + **✉️ A friendly note from the maintainer:** + + > [!NOTE] + > We are a small open-source project with a small community. + > It can sometimes take a long time for issues to be addressed, so please be patient. + > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️. + > But your issue will eventually get attention regardless. + >[undergroundwires](https://undergroundwires.dev)
+ + --- diff --git a/.github/ISSUE_TEMPLATE/2-bug-report-generic.md b/.github/ISSUE_TEMPLATE/2-bug-report-generic.md deleted file mode 100644 index da957c8d4..000000000 --- a/.github/ISSUE_TEMPLATE/2-bug-report-generic.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -name: Bug report (unrelated to generated scripts) -about: Create a bug report that's not related to generated scripts to help privacy.sexy improve -labels: bug -title: '[BUG]: ' ---- - - - -### Description - - - -### Reproduction steps - - - -### Expected behavior - - - -### Screenshots - - - -### Distribution - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.md b/.github/ISSUE_TEMPLATE/3-feature-request.md deleted file mode 100644 index 99a34742b..000000000 --- a/.github/ISSUE_TEMPLATE/3-feature-request.md +++ /dev/null @@ -1,36 +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/3-suggestion-feature.yaml b/.github/ISSUE_TEMPLATE/3-suggestion-feature.yaml new file mode 100644 index 000000000..b9a3f730d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-suggestion-feature.yaml @@ -0,0 +1,73 @@ +name: "Suggestion: Feature" +description: 💡 Suggest new ideas to enhance privacy.sexy +labels: [ 'enhancement' ] +title: '[Feature]: ' +body: + - + type: markdown + attributes: + value: |- + Thank you for contributing to privacy.sexy and guiding our direction! 🌟 + Please complete as much of the form below as possible. + Your feedback is valuable, even if you can't provide all details. + - + type: textarea + attributes: + label: Problem statement + 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. + placeholder: >- + For example: "Every time I use the app, I struggle with..." + validations: + required: true + - + type: textarea + attributes: + label: Proposed solution + description: |- + Describe the solution you'd like in a clear and concise manner. + placeholder: >- + For example: "It would be great if the app could..." + validations: + required: true + - + type: textarea + attributes: + label: Alternatives considered + description: |- + Have you considered any alternative solutions or features? + Different perspectives can inspire new ideas. + placeholder: >- + For example: "We could also solve it by...". + validations: + required: false + - + type: textarea + attributes: + label: Additional information + description: |- + If applicable, add any other context or screenshots about the feature request here. + + > **💡 Tip:** You can attach files or screenshots by dragging them into this area. + placeholder: >- + For example: "Challenges can be ..., but I'm unsure about ..., here is some documentation about it: ..." + validations: + required: false + - + type: markdown + attributes: + value: |- + --- + + **✉️ A friendly note from the maintainer:** + + > [!NOTE] + > We are a small open-source project with a small community. + > It can sometimes take a long time for issues to be addressed, so please be patient. + > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️. + > But your issue will eventually get attention regardless. + >[undergroundwires](https://undergroundwires.dev)
+ + --- diff --git a/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md b/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md deleted file mode 100644 index f07a70901..000000000 --- a/.github/ISSUE_TEMPLATE/4-new-script-suggestion.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -name: New script suggestion -about: Suggest a new script for privacy.sexy -labels: enhancement ---- - - - -### Operating system - - - -### Name - - - -### Code - - - -### Revert code - - - -### Category - - - -### Recommendation level - - - -### Documentation/References - - diff --git a/.github/ISSUE_TEMPLATE/4-suggestion-new-script.yaml b/.github/ISSUE_TEMPLATE/4-suggestion-new-script.yaml new file mode 100644 index 000000000..00fb1c02c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-suggestion-new-script.yaml @@ -0,0 +1,133 @@ +name: "Suggestion: New Script" +description: 💡 Suggest new scripts to enhance privacy.sexy +labels: [ 'enhancement' ] +title: '[New script]: ' +body: + - + type: markdown + attributes: + value: |- + Thank you for contributing to privacy.sexy and guiding our direction! 🌟 + Please complete as much of the form below as possible. + Your feedback is valuable, even if you can't provide all details. + + For guidance, see our [script guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md). + Consider submitting a PR to get your script added more quickly: (see [CONTRIBUTING.md](https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md#extend-scripts)) + - + type: dropdown + attributes: + label: Operating system + description: Which operating system will the new script configure? + options: + - macOS + - Windows + - Linux + - All of them + validations: + required: false + - + type: textarea + attributes: + label: Name of the script + description: |- + Suggest a name for the script that clearly describes its function. + + See [script naming conventions](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#name) for best practices. + placeholder: E.g, "Disable error data submission" + validations: + required: true + - + type: textarea + attributes: + label: Documentation/References + description: |- + Provide any relevant documentation or references. + Prefer high-quality sources such as vendor documentation. + + See [documentation guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#documentation) for best practices. + placeholder: >- + For example: "This script will disable the error data submission, see https://microsoft.com/...". + validations: + required: true + - + type: textarea + attributes: + label: Code + description: |- + If possible, provide or explain the code that the script should execute. + + See [script code guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#code). + placeholder: |- + For example: "Set registry key like this `reg add "HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\DataCollection" /v "AllowTelemetry" /t "REG_DWORD" /d "1"`". + validations: + required: false + - + type: textarea + attributes: + label: Revert code + description: |- + If applicable, provide revert code to restore the changes made by the script. + + The revert code restores changes to their default state before script execution. + + Leave blank for non-reversible scripts. + placeholder: |- + For example: "Revert to operating system default like this `reg add "HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\DataCollection" /v "AllowTelemetry" /t "REG_DWORD" /d "0"`". + validations: + required: false + - + type: textarea + attributes: + label: Suggested category + description: |- + Suggest a category for the script. + + If unsure, leave blank for maintainers to decide. + placeholder: >- + For example: "Privacy Cleanup > Clear system logs" + - + type: dropdown + attributes: + label: Recommendation level + description: |- + Suggest a recommendation level for the script: + + - **Standard**: Recommended for most users without side-effects. + - **Strict**: Provides improved privacy at the cost of some functionality. + - **None**: For advanced users or specific needs. + + If unsure, leave blank for maintainers to decide. + options: + - Standard + - Strict + - None (do not recommend) + validations: + required: false + - + type: textarea + attributes: + label: Additional information + description: |- + If applicable, add any other context or screenshots about the script request here. + + > **💡 Tip:** You can attach additional documents or screenshots by dragging them into this area or pasting directly. + placeholder: >- + For example: "Challenges can be ..., but I am unsure about ..." + validations: + required: false + - + type: markdown + attributes: + value: |- + --- + + **✉️ A friendly note from the maintainer:** + + > [!NOTE] + > We are a small open-source project with a small community. + > It can sometimes take a long time for issues to be addressed, so please be patient. + > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️. + > But your issue will eventually get attention regardless. + >[undergroundwires](https://undergroundwires.dev)
+ + --- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a49eab2f6..483f5ab54 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,7 @@ -blank_issues_enabled: true \ No newline at end of file +# This file must be named `config.yml`. GitHub does not recognize the file if it is named `config.yaml`. +blank_issues_enabled: true +contact_links: + - name: Donate + url: https://undergroundwires.dev/donate/ + about: ❤️ Donate for free software you love so it will not die. + # A separate link for reporting vulnerabilities is not included here because GitHub generates it automatically.