From 2e227013de5d0e6a3587f6de18220b26f1a9a77f Mon Sep 17 00:00:00 2001 From: Ujwal223 Date: Thu, 12 Nov 2026 15:52:12 +0545 Subject: [PATCH] Added templated for github issues and pull requests --- .github/ISSUE_TEMPLATE/bug_report.yml | 86 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../ISSUE_TEMPLATE/documentation_update.yml | 52 +++++++++++ .../ISSUE_TEMPLATE/feature_enhancement.yml | 51 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 43 ++++++++++ .../question_or_clarification.yml | 43 ++++++++++ .github/pull_request_template.md | 36 ++++++++ 7 files changed, 316 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_update.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question_or_clarification.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..650b5c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,86 @@ +name: Bug Report +description: Report a crash, unexpected behavior, or broken feature in FocusGram +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please fill out this form with specific details so the issue can be reproduced and resolved efficiently. Make sure you are using the latest release of FocusGram before opening a report. + - type: input + id: app_version + attributes: + label: FocusGram Version + description: Found in Settings -> About FocusGram (e.g., v3.0.0) + placeholder: "v3.0.0" + validations: + required: true + - type: input + id: device_info + attributes: + label: Device and Android Version + description: Device manufacturer, model, and Android OS version + placeholder: "e.g., Google Pixel 7, Android 14" + validations: + required: true + - type: dropdown + id: component + attributes: + label: Affected Component + options: + - Content Blocker / Ads + - Focus Gates (Breath, Friction, Cooldown) + - Daily Limits & Session Timers + - Direct Messages & Notifications + - Chat Lock & App Lock + - Media Downloader & Ghost Mode + - Settings & General Navigation + - Other / Not Sure + validations: + required: true + - type: textarea + id: description + attributes: + label: Problem Description + description: A clear and detailed description of what happened. + validations: + required: true + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: Exact steps to reproduce the issue. + placeholder: | + 1. Open FocusGram + 2. Navigate to ... + 3. Trigger ... + 4. See error or unexpected behavior + validations: + required: true + - type: textarea + id: expected_vs_actual + attributes: + label: Expected vs Observed Behavior + description: What did you expect to happen, and what happened instead? + validations: + required: true + - type: textarea + id: logs_or_screenshots + attributes: + label: Relevant Logcat Snippets or Screenshots + description: Optional. Please ensure any attached text or images do not contain personal names, account IDs, or private message content. + validations: + required: false + - type: checkboxes + id: mandatory_checks + attributes: + label: Mandatory Confirmations + options: + - label: I am a human, I know what I am creating this issue for, and I am not filing this issue blindly based on an AI agent. + required: true + - label: I am sure the language of my Instagram account is set to English and nothing else. + required: true + - label: I confirm this report does NOT contain any passwords, tokens, session cookies, or personal DM text. + required: true + - label: I searched open and closed issues and verified this is not a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..da7f803 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Security Vulnerability Report + url: https://github.com/Ujwal223/FocusGram/security/policy + about: For reporting security vulnerabilities privately under our security policy. diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yml b/.github/ISSUE_TEMPLATE/documentation_update.yml new file mode 100644 index 0000000..ace1c12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.yml @@ -0,0 +1,52 @@ +name: Documentation Update +description: Suggest corrections or improvements for documentation, README, code comments, or tests +title: "[Docs]: " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + Please note: As stated in `AGENTS.md` and `CONTRIBUTING.md`, FocusGram does not accept pull requests that contain solely documentation fixes, comment cleanups, cosmetic reformatting, or test additions without implementation. Please submit your observations here instead so they can be reviewed and applied. + - type: dropdown + id: category + attributes: + label: Target Category + options: + - README or Markdown Documentation + - In-code Comments / Typos + - Architecture or Sandboxing Guidelines + - Fastlane Metadata / Store Listings + - Unit / Integration Test Additions + validations: + required: true + - type: input + id: affected_files + attributes: + label: Affected File(s) and Line Number(s) + description: Provide the specific file paths and line ranges. + placeholder: "e.g., README.md (lines 40-45)" + validations: + required: true + - type: textarea + id: proposed_changes + attributes: + label: Proposed Changes + description: Provide the exact suggested wording or diff. + validations: + required: true + - type: textarea + id: justification + attributes: + label: Reason for Change + description: Explain why this clarification, correction, or test addition is necessary. + validations: + required: true + - type: checkboxes + id: mandatory_checks + attributes: + label: Mandatory Confirmations + options: + - label: I am a human, I know what I am creating this issue for, and I am not filing this issue blindly based on an AI agent. + required: true + - label: I understand that documentation-only and comment-only PRs are automatically rejected, and I will wait for maintainer review on this issue. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_enhancement.yml b/.github/ISSUE_TEMPLATE/feature_enhancement.yml new file mode 100644 index 0000000..c7ab17b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_enhancement.yml @@ -0,0 +1,51 @@ +name: Feature Enhancement +description: Suggest an improvement, refinement, or tweak to an existing FocusGram feature +title: "[Enhancement]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Use this template to suggest enhancements to features that already exist in FocusGram. + - type: input + id: target_feature + attributes: + label: Target Feature + description: Which existing feature needs improvement? (e.g., Breath Gate, Cooldown Timer, Bio Stylist, App Lock) + placeholder: "e.g., Daily Limit Gate" + validations: + required: true + - type: textarea + id: current_limitation + attributes: + label: Current Limitation + description: What is currently lacking, inconvenient, or could work better? + validations: + required: true + - type: textarea + id: proposed_improvement + attributes: + label: Proposed Enhancement + description: Describe your proposed change in clear detail. + validations: + required: true + - type: textarea + id: user_benefit + attributes: + label: Practical Wellness Value + description: How does this change help users maintain digital wellness or improve focus? + validations: + required: true + - type: checkboxes + id: mandatory_checks + attributes: + label: Mandatory Confirmations + options: + - label: I am a human, I know what I am creating this issue for, and I am not filing this issue blindly based on an AI agent. + required: true + - label: I am sure the language of my Instagram account is set to English and nothing else. + required: true + - label: This improvement operates 100% locally on-device without telemetry or off-device network calls. + required: true + - label: I searched open and closed issues and confirmed this enhancement has not already been proposed. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..bfe99d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: Feature Request +description: Propose a new digital wellness, intentionality, or focus feature +title: "[Feature]: " +labels: ["feature-request"] +body: + - type: markdown + attributes: + value: | + FocusGram is a distraction-free client designed to encourage intentional use of Instagram. All features must be client-side only, operate 100% locally on-device, and never automate user actions. + - type: textarea + id: problem_statement + attributes: + label: Problem Statement + description: What challenge, distraction loop, or user friction are you trying to address? + validations: + required: true + - type: textarea + id: proposed_feature + attributes: + label: Proposed Feature Concept + description: Describe the new feature and how a user interacts with it. + validations: + required: true + - type: textarea + id: configuration + attributes: + label: Settings & User Control + description: Where and how should this feature be toggled or configured in the Settings menu? + validations: + required: true + - type: checkboxes + id: mandatory_checks + attributes: + label: Mandatory Confirmations + options: + - label: I am a human, I know what I am creating this issue for, and I am not filing this issue blindly based on an AI agent. + required: true + - label: This feature operates 100% locally on-device and requires zero off-device telemetry or cloud services. + required: true + - label: This feature does NOT automate Instagram interactions (no auto-liking, auto-scrolling, or bots). + required: true + - label: I searched open and closed issues and confirmed this feature has not already been requested. + required: true diff --git a/.github/ISSUE_TEMPLATE/question_or_clarification.yml b/.github/ISSUE_TEMPLATE/question_or_clarification.yml new file mode 100644 index 0000000..922075c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_or_clarification.yml @@ -0,0 +1,43 @@ +name: Question or Clarification +description: Ask a question about FocusGram architecture, privacy boundaries, or configuration +title: "[Question]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Before submitting a question, please review the README, SECURITY.md, and the in-app Welcome & Privacy Guide to see if your question is already answered. + - type: input + id: topic + attributes: + label: Topic Summary + description: A concise summary of what you are asking about. + placeholder: "e.g., How does Chat Lock handle multi-account logins?" + validations: + required: true + - type: textarea + id: question_details + attributes: + label: Question Details + description: Provide clear context and describe what you are trying to understand. + validations: + required: true + - type: textarea + id: sources_checked + attributes: + label: Resources Checked + description: Which files or settings screens have you already inspected? + placeholder: "e.g., Read README.md, SECURITY.md, and checked Settings -> Security" + validations: + required: true + - type: checkboxes + id: mandatory_checks + attributes: + label: Mandatory Confirmations + options: + - label: I am a human, I know what I am creating this issue for, and I am not filing this issue blindly based on an AI agent. + required: true + - label: I am sure the language of my Instagram account is set to English and nothing else. + required: true + - label: I checked existing documentation and issues to verify this question was not already answered. + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e0ec2ac --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ + + +## Associated Issue +Closes # + +## Summary of Changes + + +## Architectural Layer + +- [ ] `core.engine` (GeckoView runtime, session management, WebExtension bridge) +- [ ] `core.datastore` / `core.database` (Local state, Room SQLite, DataStore) +- [ ] `feature.*` (Settings, Session, Guardrails, Notifications, Lock) +- [ ] `assets/scripts/` or `assets/extensions/content-engine/` (Web scripts) +- [ ] Build configuration or CI/CD workflows + +## Mandatory Confirmations + +- [ ] I am a human contributor, I understand the code in this PR, and I am not blindly submitting output from an AI agent. +- [ ] I have verified that Instagram language is set to English during all testing. +- [ ] This PR is NOT documentation-only, comment-only, test-only, cosmetic formatting, or an unsolicited dependency update. +- [ ] All web modifications reside in `assets/scripts/` or `assets/extensions/content-engine/` (zero inline JavaScript strings in Kotlin files). +- [ ] This change does not touch, inspect, or intercept Instagram login flows, credentials, 2FA tokens, or cookies. +- [ ] This change transmits zero telemetry, analytics, or user data off-device. +- [ ] This change does not automate user actions (no auto-liking, auto-scrolling, or bots). +- [ ] Any newly introduced feature is independently toggleable from Settings. + +## Testing & Verification + +- [ ] Local unit test suite passed: `./gradlew :app:testDebugUnitTest` +- [ ] Debug APK assembled successfully: `./gradlew :app:assembleDebug` +- [ ] Tested on a physical device or emulator (Device: , Android Version: )