Skip to content
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

Merged
merged 1 commit into from
Jan 4, 2025
Merged

Conversation

PeterDaveHello
Copy link
Owner

@PeterDaveHello PeterDaveHello commented Jan 4, 2025

🎉

Summary by CodeRabbit

  • Documentation
    • Added a new issue template for reporting URL shortener domain problems
    • Added a new pull request template for managing shortener domains
    • Both templates aim to improve communication and clarity in issue and pull request submissions

@PeterDaveHello PeterDaveHello requested a review from Copilot January 4, 2025 12:11
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jan 4, 2025

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.

Copy link

coderabbitai bot commented Jan 4, 2025

📝 Walkthrough

Walkthrough

A 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

File Change Summary
.github/ISSUE_TEMPLATE/issue_template.md New issue template created for reporting URL shortener domain problems, with sections for description, involved domains, verification examples, steps, and additional context
.github/pull_request_template.md New pull request template introduced for managing shortener domains, including description, domain usage proof, checklist, rationale, and additional notes sections

Sequence Diagram

sequenceDiagram
    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
Loading

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jan 4, 2025
Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between fe20514 and 75bc671.

📒 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)

@PeterDaveHello PeterDaveHello merged commit 061d6d0 into master Jan 4, 2025
4 checks passed
@PeterDaveHello PeterDaveHello deleted the template branch January 4, 2025 12:17
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 size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant