Skip to content

docs: add issue templates, pull request template, and update issue links - #237

Merged
omg-xtao merged 3 commits into
NextAlone:devfrom
OsamaX0X:pr/docs-add-templates
Oct 29, 2026
Merged

omg-xtao merged 3 commits into
NextAlone:devfrom
OsamaX0X:pr/docs-add-templates

Conversation

@OsamaX0X

@OsamaX0X OsamaX0X commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

This PR brings over and sets up GitHub issue templates (bug reports, feature requests, and issue config) as well as a pull request template, tailored specifically for Nagram. We’d also like to kindly ask if you would consider enabling GitHub Issues on this repository. Why this change is great for the project:

  1. Where Developers Track Work: Developers and open-source contributors usually keep track of bugs, tasks, and progress directly on GitHub. Having issues enabled makes it much easier for contributors to discover what needs fixing, reference commits/PRs to specific issues, and contribute code.
  2. Better Organization & Persistence: Telegram topics/chats are great for real-time discussion, but reports and feature suggestions easily get buried or lost. GitHub Issues allows structured tracking with labels, milestones, open/closed states, reproduction steps, and log attachments.
  3. Common Standard Across Telegram Forks: Most forks (such as Nekogram, Nullgram, OwlGram, etc.) keep issues open to encourage open collaboration and community contributions.
  4. Fewer Duplicate Reports: Users and contributors can easily search existing and closed issues before submitting, reducing repeated inquiries across discussion groups.
  5. Structured Intake via Templates: The added templates ensure all necessary details (device specs, app version, logs, steps to reproduce) are collected upfront, saving maintainer time when troubleshooting.

Both GitHub Issues and Telegram reports links are kept in README.md so users can still reach out via whichever platform they prefer.

Summary by Sourcery

Standardize contribution and issue intake through GitHub templates while preserving Telegram reporting channels.

New Features:

  • Add structured bilingual GitHub bug-report and feature-request forms with required issue details and project contact links.
  • Add a pull request template to standardize change descriptions, issue references, and contributor checklists.

Enhancements:

  • Replace the README's single Telegram issue link with both GitHub Issues and Telegram reporting options.

Documentation:

  • Update README issue-reporting links to support GitHub Issues alongside Telegram reports.

Chores:

  • Replace legacy Markdown issue templates with GitHub form-based templates. Add issue configuration to disable blank issues.

Add bug report, feature request, and config issue templates

Add pull request template

Add GitHub Issues link alongside Telegram reports in README.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

This PR configures GitHub’s contribution workflow for Nagram by adding bilingual issue forms, restricting submissions to structured templates, providing a Telegram contact link, and standardizing pull requests with project-specific review checklists.

File-Level Changes

Change Details Files
Added structured GitHub issue intake for bug reports and feature requests, with repository-level issue configuration.
  • Added bilingual bug report form requiring reproduction steps, expected and actual behavior, device/app versions, latest debug build confirmation, and logs.
  • Added feature request form capturing the requested problem, proposed solution, and alternatives.
  • Disabled blank issues and linked users to the project’s Telegram channel for contact.
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/config.yml
Standardized pull request submissions with a reusable project-specific template.
  • Added sections for change description and linked issues.
  • Added checklist items covering testing, compatibility, code style, and commit hygiene.
.github/PULL_REQUEST_TEMPLATE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@OsamaX0X
OsamaX0X force-pushed the pr/docs-add-templates branch from 4d697d9 to 3099f44 Compare October 22, 2026 17:40
sourcery-ai[bot]
sourcery-ai Bot previously approved these changes Oct 22, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 6 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path=".github/ISSUE_TEMPLATE/bug_report.yml" line_range="1" />
<code_context>
+name: Bug report/反馈 Bug
+description: Report errors or unexpected behavior./反馈错误或异常行为。
+labels: ["Bug"]
</code_context>
<issue_to_address>
**Issue forms remain unavailable**

When the repository's Issues feature is disabled, gitHub does not expose these templates while the repository's Issues feature is disabled, so users cannot submit the intended structured reports. Enable Issues in the repository settings for the templates to be usable.

Enable Issues in the repository settings so GitHub displays the added templates.
</issue_to_address>

### Comment 2
<location path=".github/ISSUE_TEMPLATE/bug_report.yml" line_range="56" />
<code_context>
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    attributes:
</code_context>
<issue_to_address>
**Release users cannot submit reports**

When a reporter uses a stable release or cannot enable verbose logging, the required checkbox blocks the bug report unless the reporter claims to use the latest debug CI version with verbose logging enabled, so they cannot submit a truthful report.

Make the version and logging checkbox optional or informational instead of required.
</issue_to_address>

### Comment 3
<location path=".github/ISSUE_TEMPLATE/bug_report.yml" line_range="55-63" />
<code_context>
+    attributes:
+      label: Version requirement
+      options:
+        - label: I am using latest debug CI version of Nagram and enable verbose log/我正在使用最新 CI 调试版本且启用详细日志
+          required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: For usage issues, please provide the log. Without log, the issue will be closed. /使用问题请提供日志;无日志提交会被关闭。
+      placeholder: Upload logs by clicking the bar on the bottom. 
+    validations:
+      required: true
</code_context>
<issue_to_address>
**Bug reports get blocked**

When a user encounters a bug on a release build or cannot provide a log, gitHub form validation rejects a report unless the submitter checks that they use the latest debug CI build with verbose logging and supplies a log, so users reporting bugs on a normal release build or without logs cannot submit it.

Make the debug-build checkbox and logs optional, or apply those requirements only to reports where they are relevant.
</issue_to_address>

### Comment 4
<location path=".github/ISSUE_TEMPLATE/bug_report.yml" line_range="1" />
<code_context>
+name: Bug report/反馈 Bug
+description: Report errors or unexpected behavior./反馈错误或异常行为。
+labels: ["Bug"]
</code_context>
<issue_to_address>
**Incomplete reports bypass validation**

When gitHub displays the Markdown templates alongside the new forms, reporters can choose a legacy template and submit without the new required fields; the legacy bug form also directs users to NekoXChat, routing Nagram reports to the wrong support channel.

Remove or update the legacy Markdown templates so reporters use the Nagram forms.

Also at `.github/ISSUE_TEMPLATE/feature_request.yml:1`, `.github/ISSUE_TEMPLATE/config.yml:1`.
</issue_to_address>

### Comment 5
<location path=".github/ISSUE_TEMPLATE/config.yml" line_range="4" />
<code_context>
+blank_issues_enabled: false
+contact_links:
+  - name: channel
+    url: https://t.me/nagram_channel
+    about: Our Telegram Channel
</code_context>
<issue_to_address>
**Telegram contact link misroutes reporters**

When a user follows the Telegram contact link from the issue chooser, the contact link sends users to `nagram_channel`, while the README identifies `na_gram_reports/18` as the place to report issues. Users who choose the Telegram route are directed away from the reporting destination.

Point the contact link to the Telegram reports destination, or label the channel link clearly as a non-reporting resource.
</issue_to_address>

### Comment 6
<location path=".github/ISSUE_TEMPLATE/config.yml" line_range="4" />
<code_context>
+blank_issues_enabled: false
+contact_links:
+  - name: channel
+    url: https://t.me/nagram_channel
+    about: Our Telegram Channel
</code_context>
<issue_to_address>
**GitHub reporting stays undiscoverable**

When readers use the README to find where to report an issue, `README.md` still directs readers only to Telegram, so users following the project's documented issue route never discover the new GitHub forms. Add a GitHub Issues link alongside the existing Telegram link in the README.

Add the GitHub Issues URL to the README alongside the existing Telegram report link.
</issue_to_address>

Sourcery assessment

Approval pending. 6 findings to address first.

Blocking findings: .github/ISSUE_TEMPLATE/bug_report.yml:1, .github/ISSUE_TEMPLATE/bug_report.yml:56, .github/ISSUE_TEMPLATE/bug_report.yml:63, .github/ISSUE_TEMPLATE/bug_report.yml:1, .github/ISSUE_TEMPLATE/config.yml:4, and 1 more


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@@ -0,0 +1,64 @@
name: Bug report/反馈 Bug

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Medium · Issue forms remain unavailable

When the repository's Issues feature is disabled, gitHub does not expose these templates while the repository's Issues feature is disabled, so users cannot submit the intended structured reports. Enable Issues in the repository settings for the templates to be usable.

Enable Issues in the repository settings so GitHub displays the added templates.

Prompt for AI agents
In `.github/ISSUE_TEMPLATE/bug_report.yml` at line 1:

**Issue forms remain unavailable**

When the repository's Issues feature is disabled, gitHub does not expose these templates while the repository's Issues feature is disabled, so users cannot submit the intended structured reports. Enable Issues in the repository settings for the templates to be usable.

Enable Issues in the repository settings so GitHub displays the added templates.

Comment thread .github/ISSUE_TEMPLATE/bug_report.yml Outdated
Comment thread .github/ISSUE_TEMPLATE/bug_report.yml
Comment thread .github/ISSUE_TEMPLATE/bug_report.yml
Comment thread .github/ISSUE_TEMPLATE/config.yml
Comment thread .github/ISSUE_TEMPLATE/config.yml
@sourcery-ai
sourcery-ai Bot dismissed their stale review October 22, 2026 17:48

Sourcery withdrew this approval because the latest commits introduced blocking findings.

@waifucon waifucon left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

@omg-xtao omg-xtao added the documentation Improvements or additions to documentation label Oct 29, 2026
@omg-xtao
omg-xtao merged commit 1d1d4d3 into NextAlone:dev Oct 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants