Repository navigation
docs: add issue templates, pull request template, and update issue links - #237
Conversation
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>
Reviewer's GuideThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
4d697d9 to
3099f44
Compare
There was a problem hiding this comment.
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
| @@ -0,0 +1,64 @@ | |||
| name: Bug report/反馈 Bug | |||
There was a problem hiding this comment.
🟡 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.Sourcery withdrew this approval because the latest commits introduced blocking findings.
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:
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:
Enhancements:
Documentation:
Chores: