kimseungbin / tag-and-release

A GitHub repository demonstrating automated releases using semantic versioning and a custom JavaScript GitHub Action. This project automates the tagging and release process, ensuring consistent version control and streamlined workflows.
BSD Zero Clause License
0 stars 0 forks source link

Add new issue templates and update pull request template for standardization #11

Closed kimseungbin closed 18 hours ago

kimseungbin commented 18 hours ago

Summary by CodeRabbit

Close #9

coderabbitai[bot] commented 18 hours ago

Walkthrough

A set of new issue templates has been added to the .github/ISSUE_TEMPLATE directory, including templates for breaking changes, bug reports, feature requests, and infrastructure tasks. Each template is structured to guide users in providing detailed and relevant information. Additionally, the pull request template has been updated to include placeholders for summaries and issue closure. These changes aim to standardize documentation processes for issues and pull requests within the project.

Changes

File Path Change Summary
.github/ISSUE_TEMPLATE/breaking_change.md New issue template for documenting breaking changes.
.github/ISSUE_TEMPLATE/bug_report.md New issue template for reporting bugs.
.github/ISSUE_TEMPLATE/feature_request.md New issue template for feature requests.
.github/ISSUE_TEMPLATE/infrastructure_task.md New issue template for tracking infrastructure tasks.
.github/pull_request_template.md Added lines for summary and issue closure in PR template.

Assessment against linked issues

Objective Addressed Explanation
Add issue templates βœ…
Add PR templates βœ…

🐰 In the garden where ideas bloom,
New templates sprout, dispelling gloom.
For bugs and features, a structured way,
To share our thoughts, come what may!
With every change, our process grows,
Hop along, dear friends, to where clarity flows! 🌼

[!WARNING]

Rate limit exceeded

@kimseungbin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 29 seconds before requesting another review.

βŒ› How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 1f862a583fc9c6ca403e2bec2902b10d4b0b5425 and 444921beb2df1d60a59cae6a238dd4a90dbf7c81.

πŸ“œ Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 1f862a583fc9c6ca403e2bec2902b10d4b0b5425 and 444921beb2df1d60a59cae6a238dd4a90dbf7c81.
πŸ“’ Files selected for processing (5) * `.github/ISSUE_TEMPLATE/breaking_change.md` (1 hunks) * `.github/ISSUE_TEMPLATE/bug_report.md` (1 hunks) * `.github/ISSUE_TEMPLATE/feature_request.md` (1 hunks) * `.github/ISSUE_TEMPLATE/infrastructure_task.md` (1 hunks) * `.github/pull_request_template.md` (1 hunks)
βœ… Files skipped from review due to trivial changes (4) * .github/ISSUE_TEMPLATE/breaking_change.md * .github/ISSUE_TEMPLATE/bug_report.md * .github/ISSUE_TEMPLATE/infrastructure_task.md * .github/pull_request_template.md
🧰 Additional context used
πŸͺ› LanguageTool
.github/ISSUE_TEMPLATE/feature_request.md [style] ~32-~32: To make your writing concise, consider an alternative. Context: ... challenges or considerations we should be aware of when implementing this feature? - How d... (AWARE_OF) --- [style] ~34-~34: The phrase β€˜feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. Context: ...d to or impact existing functionality? Feel free to attach screenshots, links or any other ... (FEEL_FREE_TO_STYLE_ME)

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.