-
-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a basic issue and pull request template #112
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
📝 WalkthroughWalkthroughA new set of GitHub issue and pull request templates have been introduced specifically for managing URL shortener domains. These templates are designed to provide a structured format for reporting issues and submitting changes related to shortener domains. The templates include comprehensive sections that guide contributors to provide detailed information, verification examples, and rationale for their submissions, ultimately aiming to improve the clarity and quality of domain-related communications. Changes
Sequence DiagramsequenceDiagram
participant Contributor
participant IssueTemplate
participant PullRequestTemplate
Contributor->>IssueTemplate: Fill out issue details
Contributor->>PullRequestTemplate: Submit domain changes
PullRequestTemplate->>Contributor: Prompt for:
- Domain description
- Usage proof
- Verification checklist
- Rationale
IssueTemplate->>Contributor: Request:
- Problem description
- Involved domains
- Verification examples
- Confirmation steps
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (5)
.github/ISSUE_TEMPLATE/issue_template.md (2)
13-16
: Add language specification to the code block.Specify the language for the code block to improve syntax highlighting and follow markdown best practices.
-``` +```txt 1. http://short.example/abc -> https://www.actual-domain.com/page1 2. ...🧰 Tools
🪛 Markdownlint (0.37.0)
13-13: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
20-21
: Enhance verification steps with specific criteria.Consider adding more specific verification steps to help users provide better quality reports.
- [ ] Confirmed the domain(s) in question are correct and relevant to shortener usage. - [ ] Provided clear evidence (links, logs, etc.) for each reported issue. +- [ ] Verified that the domain is actively serving as a URL shortener +- [ ] Checked if this issue is already reported +- [ ] Tested with multiple different short URLs from the same domain.github/pull_request_template.md (3)
3-5
: Enhance the description section with specific prompts.The description section could be more specific about the types of changes being made.
## Description -<!-- Explain what changes you are making to the shortener domains list --> +<!-- +Explain what changes you are making to the shortener domains list: +- Are you adding new domains? Which ones? +- Are you removing existing domains? Which ones? +- Are you updating information about existing domains? +-->
9-13
: Add language specification to the code block.Specify the language for the code block to improve syntax highlighting and follow markdown best practices.
-``` +```txt 1. http://short.example/abc -> https://www.actual-domain.com/page1 2. http://short.example/def -> https://www.actual-domain.com/page2 3. ...🧰 Tools
🪛 Markdownlint (0.37.0)
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
15-19
: Expand the checklist with comprehensive verification items.The current checklist could be more detailed to ensure quality submissions.
## Checklist - [ ] I have confirmed the shortener domain(s) are active/inactive as indicated. - [ ] I have verified that each domain's usage proof is correct and up to date. +- [ ] I have tested each domain with at least 3 different short URLs +- [ ] I have checked that the domains are not already in the list +- [ ] I have verified that the destination URLs are safe and appropriate +- [ ] I have tested the domains from different locations/IPs +- [ ] I have documented any region restrictions or limitations
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/issue_template.md
(1 hunks).github/pull_request_template.md
(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
.github/ISSUE_TEMPLATE/issue_template.md
13-13: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
.github/pull_request_template.md
9-9: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/issue_template.md (1)
1-25
: Well-structured template with comprehensive sections!The template effectively guides users to provide all necessary information for domain-related issues.
🧰 Tools
🪛 Markdownlint (0.37.0)
13-13: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
.github/pull_request_template.md (1)
1-26
: Well-structured PR template that effectively guides contributors!The template provides a clear framework for submitting domain-related changes and includes all essential sections for proper verification.
🧰 Tools
🪛 Markdownlint (0.37.0)
9-9: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🎉
Summary by CodeRabbit