diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ee39d84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,90 @@ +name: Bug Report +description: Report a bug in ProxyBridge +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform are you using? + options: + - Windows + - macOS + - Linux + validations: + required: true + + - type: input + id: version + attributes: + label: ProxyBridge Version + description: What version of ProxyBridge are you running? + placeholder: e.g., 1.0.0 + validations: + required: true + + - type: input + id: os-version + attributes: + label: OS and Version + description: What operating system and version are you using? + placeholder: e.g., Windows 11 23H2, macOS 14.2 Sonoma, Ubuntu 22.04 + validations: + required: true + + - type: checkboxes + id: documentation + attributes: + label: Documentation + description: Have you read the documentation for your platform? + options: + - label: I have read the [Windows documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/Windows/README.md) + required: false + - label: I have read the [macOS documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/MacOS/README.md) + required: false + - label: I have read the [Linux documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/Linux/README.md) + required: false + + - type: checkboxes + id: code-review + attributes: + label: Code Review + description: Have you reviewed the code? + options: + - label: I have gone through the code page + required: false + + - type: textarea + id: description + attributes: + label: Describe the Bug + description: | + Please provide a clear and detailed description of the bug. + + **If applicable, please include:** + - Screenshots or error messages + - Steps to reproduce the issue + - Expected behavior vs actual behavior + placeholder: | + Steps to reproduce: + 1. Go to '...' + 2. Click on '...' + 3. See error + + Expected behavior: ... + Actual behavior: ... + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here (logs, configuration files, etc.) + placeholder: Paste any relevant logs or additional information here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..eafc005 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://github.com/InterceptSuite/ProxyBridge + about: Check the documentation before creating an issue diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..76d5584 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,89 @@ +name: Feature Request +description: Suggest a new feature for ProxyBridge +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest a new feature! + + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform is this feature request for? + options: + - Windows + - macOS + - Linux + - All platforms + validations: + required: true + + - type: input + id: version + attributes: + label: ProxyBridge Version + description: What version of ProxyBridge are you currently using? + placeholder: e.g., 1.0.0 + validations: + required: true + + - type: input + id: os-version + attributes: + label: OS and Version + description: What operating system and version are you using? + placeholder: e.g., Windows 11 23H2, macOS 14.2 Sonoma, Ubuntu 22.04 + validations: + required: true + + - type: checkboxes + id: documentation + attributes: + label: Documentation + description: Have you read the documentation for your platform? + options: + - label: I have read the [Windows documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/Windows/README.md) + required: false + - label: I have read the [macOS documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/MacOS/README.md) + required: false + - label: I have read the [Linux documentation](https://github.com/InterceptSuite/ProxyBridge/blob/master/Linux/README.md) + required: false + + - type: checkboxes + id: code-review + attributes: + label: Code Review + description: Have you reviewed the code? + options: + - label: I have gone through the code page + required: false + + - type: textarea + id: description + attributes: + label: Describe the Feature + description: | + Please provide a clear and detailed description of the feature you'd like to see. + + **Please include:** + - What problem does this feature solve? + - How should it work? + - Any mockups or examples (if applicable) + placeholder: | + Problem: I would like to be able to... + + Proposed solution: The feature should... + + Benefits: This would help with... + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, screenshots, or examples about the feature request here + placeholder: Any additional information that might be helpful diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c5226f3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,115 @@ +# Pull Request + +## ⚠️ IMPORTANT - READ BEFORE SUBMITTING + +### Required Pre-Submission Checklist + +- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) file +- [ ] I have created a GitHub issue for this change and linked it below +- [ ] I have forked the **`dev`** branch (NOT `master`) +- [ ] I understand that the `master` branch is ONLY updated when a new release is created +- [ ] I understand that pull requests to `master` will be **REJECTED** + +### ⛔ Critical Information + +**DO NOT submit a pull request directly to the `master` branch.** The master branch is only updated when a new release is created. No direct commits or merges are accepted to master - neither from the InterceptSuite team nor from contributors. + +**All changes MUST be submitted to the `dev` branch**, which contains the latest code and commits. + +**You MUST create a GitHub issue first** before submitting a pull request. This allows the InterceptSuite team to: +- Verify if the bug is already fixed in the development branch +- Confirm if a new feature is accepted and approved +- Avoid duplicate work + +Pull requests without an associated issue will be rejected. + +--- + +## Pull Request Details + +### Type of Change + +- [ ] Bug Fix +- [ ] New Feature +- [ ] Code Improvement/Refactoring +- [ ] Documentation Update +- [ ] Other (please describe): + +### Related GitHub Issue +**Issue Link:** + + +### Platform(s) Affected + +- [ ] Windows +- [ ] macOS +- [ ] Linux +- [ ] Cross-platform/All + +--- + +## macOS Application Changes + +### Does this pull request include changes to the macOS application? +- [ ] Yes +- [ ] No + +**If YES, you MUST answer the following:** + +### macOS Code Signing & Verification + + +- [ ] I have signed the macOS app with a valid Apple Developer account +- [ ] I have run the signed application on macOS to verify my changes work as expected +- [ ] I confirm the application launches and functions correctly with my changes + +**⚠️ Important:** If you cannot sign the macOS app to verify your code changes work, please DO NOT submit this pull request. Instead, use the GitHub issue you created to let the InterceptSuite team fix the bug or add the feature. You will need to wait for the next release. + +--- + +## Description of Changes + +### What does this pull request do? + + + +### How has this been tested? + +- Test environment (OS, version, etc.): +- Test steps: +- Test results: + + +### Compilation & Dependencies +- [ ] I have reviewed the [CONTRIBUTING.md](../CONTRIBUTING.md) file for compilation instructions +- [ ] I have verified all required libraries and packages are documented +- [ ] My changes compile without errors +- [ ] My changes do not introduce new dependencies (or I have documented them below) + +**New dependencies (if any):** + + + +--- + +## Screenshots/Logs (if applicable) + + + +--- + +## Additional Context + + + +--- + +## Final Checklist + +- [ ] My code follows the project's coding style +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have updated documentation as needed +- [ ] My changes do not generate new warnings or errors +- [ ] I have tested my changes on the target platform(s) +- [ ] I have verified this change is based on the latest `dev` branch +- [ ] I understand that pull requests without an associated GitHub issue will be rejected diff --git a/README.md b/README.md index c58379f..a5e03ed 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,22 @@ ProxyBridge is a lightweight, open-source universal proxy client (Proxifier alte - **Process exclusion** - Prevent proxy loops by excluding proxy applications - **Import/Export rules** - Share rule configurations across systems with JSON-based import/export +> [!CAUTION] +> **Beware of Fake ProxyBridge Downloads** +> +> Multiple **fake ProxyBridge download sources** have been identified. Some of these sources distribute **unwanted binaries** and **malicious software**. +> +> ❌ **Do NOT download ProxyBridge from any third-party or unofficial sources.** +> +> ✅ **Official ProxyBridge sources (only):** +> - GitHub Repository: https://github.com/InterceptSuite/ProxyBridge/ +> - Official Website: [https://interceptsuite.com/download/proxybridge](https://interceptsuite.com/download/proxybridge) +> +> If you prefer not to use prebuilt binaries, you may safely build ProxyBridge yourself by following the **Contribution Guide** and compiling directly from the **official source code**. +> +> ProxyBridge does not communicate with any external servers except the GitHub API for update checks (triggered only on app launch or manual update checks); + + ## Platform Documentation