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

Docs: Feature item from RFC #48 #49

Merged
merged 1 commit into from
Jul 24, 2024
Merged

Conversation

black7375
Copy link
Contributor

@black7375 black7375 commented Jul 24, 2024

Description

A template created to make it easy to create a feature issue from an RFC.

Related Issue

Summary by CodeRabbit

  • New Features
    • Introduced a structured template for submitting feature requests derived from RFCs, enhancing clarity and communication within the working group.
    • Key fields added include Problem Description, Related RFC, Proposed Solution, Visual Aids, Alternative Solutions, and Additional Context.

Additional context

Checklist

@black7375 black7375 added the documentation Improvements or additions to documentation label Jul 24, 2024
Copy link

coderabbitai bot commented Jul 24, 2024

Walkthrough

A new YAML template for submitting feature requests derived from RFCs has been introduced. This structured template enhances clarity, encourages thoroughness, and standardizes communication within collaborative environments. Key fields prompt users to articulate problems, link relevant RFCs, propose solutions, and provide additional context, streamlining the evaluation and decision-making process.

Changes

File Path Change Summary
.github/ISSUE_TEMPLATE/feature_requests_from_rfc.yml Introduced a structured template for feature requests from RFCs, including fields for problem description, related RFC, proposed solution, visual aids, alternative solutions, and additional context.

Poem

In the warren where ideas bloom,
A new template dispels the gloom.
With fields so clear and guidance bright,
Feature dreams take joyful flight!
Hop along, let visions share,
Rabbit's wisdom fills the air! 🐰✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link
Contributor

Triggered from #49 by @​black7375.

Checking if we can fast forward main (c62ffe7) to feature-request-rfc (67928c1).

Target branch (main):

commit c62ffe7f4c4529be858e5d790f072a526933dcc0 (HEAD -> main, origin/main, origin/HEAD)
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Jul 22 01:32:15 2024 +0000

    Chore(deps-dev): Bump the dev-dependencies group with 12 updates
    
    Bumps the dev-dependencies group with 12 updates:
    
    | Package | From | To |
    | --- | --- | --- |
    | [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) | `20.14.10` | `20.14.11` |
    | [@vitest/coverage-v8](https://github.com/vitest-dev/vitest/tree/HEAD/packages/coverage-v8) | `2.0.2` | `2.0.3` |
    | [terser](https://github.com/terser/terser) | `5.31.2` | `5.31.3` |
    | [turbo](https://github.com/vercel/turbo) | `2.0.6` | `2.0.9` |
    | [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) | `5.3.3` | `5.3.4` |
    | [vite-node](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vite-node) | `2.0.2` | `2.0.3` |
    | [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) | `2.0.2` | `2.0.3` |
    | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) | `7.16.0` | `7.16.1` |
    | [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) | `5.1.3` | `5.2.1` |
    | [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) | `7.16.0` | `7.16.1` |
    | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) | `7.16.0` | `7.16.1` |
    | [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) | `0.4.8` | `0.4.9` |
    
    
    Updates `@types/node` from 20.14.10 to 20.14.11
    - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
    - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)
    
    Updates `@vitest/coverage-v8` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/coverage-v8)
    
    Updates `terser` from 5.31.2 to 5.31.3
    - [Changelog](https://github.com/terser/terser/blob/master/CHANGELOG.md)
    - [Commits](https://github.com/terser/terser/compare/v5.31.2...v5.31.3)
    
    Updates `turbo` from 2.0.6 to 2.0.9
    - [Release notes](https://github.com/vercel/turbo/releases)
    - [Changelog](https://github.com/vercel/turbo/blob/main/release.md)
    - [Commits](https://github.com/vercel/turbo/compare/v2.0.6...v2.0.9)
    
    Updates `vite` from 5.3.3 to 5.3.4
    - [Release notes](https://github.com/vitejs/vite/releases)
    - [Changelog](https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md)
    - [Commits](https://github.com/vitejs/vite/commits/v5.3.4/packages/vite)
    
    Updates `vite-node` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/vite-node)
    
    Updates `vitest` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/vitest)
    
    Updates `@typescript-eslint/parser` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/parser)
    
    Updates `eslint-plugin-prettier` from 5.1.3 to 5.2.1
    - [Release notes](https://github.com/prettier/eslint-plugin-prettier/releases)
    - [Changelog](https://github.com/prettier/eslint-plugin-prettier/blob/master/CHANGELOG.md)
    - [Commits](https://github.com/prettier/eslint-plugin-prettier/compare/v5.1.3...v5.2.1)
    
    Updates `typescript-eslint` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/typescript-eslint)
    
    Updates `@typescript-eslint/eslint-plugin` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/eslint-plugin)
    
    Updates `eslint-plugin-react-refresh` from 0.4.8 to 0.4.9
    - [Release notes](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases)
    - [Changelog](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md)
    - [Commits](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.4.8...v0.4.9)
    
    ---
    updated-dependencies:
    - dependency-name: "@types/node"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@vitest/coverage-v8"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: terser
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: turbo
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vite
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vite-node
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vitest
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@typescript-eslint/parser"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: eslint-plugin-prettier
      dependency-type: direct:development
      update-type: version-update:semver-minor
      dependency-group: dev-dependencies
    - dependency-name: typescript-eslint
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@typescript-eslint/eslint-plugin"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: eslint-plugin-react-refresh
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    ...
    
    Signed-off-by: dependabot[bot] <[email protected]>

Pull request (feature-request-rfc):

commit 67928c1260078e36d473f2d4a9a23585c7f3ff15 (pull_request/feature-request-rfc)
Author: alstjr7375 <[email protected]>
Date:   Wed Jul 24 22:16:59 2024 +0900

    Docs: Feature item from RFC #48

It is possible to fast forward main (c62ffe7) to feature-request-rfc (67928c1). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to feature-request-rfc.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c62ffe7 and 67928c1.

Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/feature_requests_from_rfc.yml (1 hunks)
Additional comments not posted (6)
.github/ISSUE_TEMPLATE/feature_requests_from_rfc.yml (6)

1-3: LGTM!

The metadata fields (name, description, labels) are correctly formatted.


5-14: LGTM!

The problem section is well-defined, with appropriate attributes and validations.


15-23: LGTM!

The related-rfc section is well-defined, with appropriate attributes and validations.


24-32: LGTM!

The solution section is well-defined, with appropriate attributes and optional validations.


33-41: LGTM!

The screenshots section is well-defined, with appropriate attributes and optional validations.


42-58: LGTM!

The alternatives and additional-context sections are well-defined, with appropriate attributes and optional validations.

@black7375
Copy link
Contributor Author

/fast-forward

Copy link
Contributor

Triggered from #49 (comment) by @​black7375.

Trying to fast forward main (c62ffe7) to feature-request-rfc (67928c1).

Target branch (main):

commit c62ffe7f4c4529be858e5d790f072a526933dcc0 (HEAD -> main, origin/main, origin/HEAD)
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Jul 22 01:32:15 2024 +0000

    Chore(deps-dev): Bump the dev-dependencies group with 12 updates
    
    Bumps the dev-dependencies group with 12 updates:
    
    | Package | From | To |
    | --- | --- | --- |
    | [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) | `20.14.10` | `20.14.11` |
    | [@vitest/coverage-v8](https://github.com/vitest-dev/vitest/tree/HEAD/packages/coverage-v8) | `2.0.2` | `2.0.3` |
    | [terser](https://github.com/terser/terser) | `5.31.2` | `5.31.3` |
    | [turbo](https://github.com/vercel/turbo) | `2.0.6` | `2.0.9` |
    | [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) | `5.3.3` | `5.3.4` |
    | [vite-node](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vite-node) | `2.0.2` | `2.0.3` |
    | [vitest](https://github.com/vitest-dev/vitest/tree/HEAD/packages/vitest) | `2.0.2` | `2.0.3` |
    | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) | `7.16.0` | `7.16.1` |
    | [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) | `5.1.3` | `5.2.1` |
    | [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) | `7.16.0` | `7.16.1` |
    | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) | `7.16.0` | `7.16.1` |
    | [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) | `0.4.8` | `0.4.9` |
    
    
    Updates `@types/node` from 20.14.10 to 20.14.11
    - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
    - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)
    
    Updates `@vitest/coverage-v8` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/coverage-v8)
    
    Updates `terser` from 5.31.2 to 5.31.3
    - [Changelog](https://github.com/terser/terser/blob/master/CHANGELOG.md)
    - [Commits](https://github.com/terser/terser/compare/v5.31.2...v5.31.3)
    
    Updates `turbo` from 2.0.6 to 2.0.9
    - [Release notes](https://github.com/vercel/turbo/releases)
    - [Changelog](https://github.com/vercel/turbo/blob/main/release.md)
    - [Commits](https://github.com/vercel/turbo/compare/v2.0.6...v2.0.9)
    
    Updates `vite` from 5.3.3 to 5.3.4
    - [Release notes](https://github.com/vitejs/vite/releases)
    - [Changelog](https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md)
    - [Commits](https://github.com/vitejs/vite/commits/v5.3.4/packages/vite)
    
    Updates `vite-node` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/vite-node)
    
    Updates `vitest` from 2.0.2 to 2.0.3
    - [Release notes](https://github.com/vitest-dev/vitest/releases)
    - [Commits](https://github.com/vitest-dev/vitest/commits/v2.0.3/packages/vitest)
    
    Updates `@typescript-eslint/parser` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/parser)
    
    Updates `eslint-plugin-prettier` from 5.1.3 to 5.2.1
    - [Release notes](https://github.com/prettier/eslint-plugin-prettier/releases)
    - [Changelog](https://github.com/prettier/eslint-plugin-prettier/blob/master/CHANGELOG.md)
    - [Commits](https://github.com/prettier/eslint-plugin-prettier/compare/v5.1.3...v5.2.1)
    
    Updates `typescript-eslint` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/typescript-eslint)
    
    Updates `@typescript-eslint/eslint-plugin` from 7.16.0 to 7.16.1
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v7.16.1/packages/eslint-plugin)
    
    Updates `eslint-plugin-react-refresh` from 0.4.8 to 0.4.9
    - [Release notes](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases)
    - [Changelog](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md)
    - [Commits](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.4.8...v0.4.9)
    
    ---
    updated-dependencies:
    - dependency-name: "@types/node"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@vitest/coverage-v8"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: terser
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: turbo
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vite
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vite-node
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: vitest
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@typescript-eslint/parser"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: eslint-plugin-prettier
      dependency-type: direct:development
      update-type: version-update:semver-minor
      dependency-group: dev-dependencies
    - dependency-name: typescript-eslint
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: "@typescript-eslint/eslint-plugin"
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    - dependency-name: eslint-plugin-react-refresh
      dependency-type: direct:development
      update-type: version-update:semver-patch
      dependency-group: dev-dependencies
    ...
    
    Signed-off-by: dependabot[bot] <[email protected]>

Pull request (feature-request-rfc):

commit 67928c1260078e36d473f2d4a9a23585c7f3ff15 (pull_request/feature-request-rfc)
Author: alstjr7375 <[email protected]>
Date:   Wed Jul 24 22:16:59 2024 +0900

    Docs: Feature item from RFC #48

Fast forwarding main (c62ffe7) to feature-request-rfc (67928c1).

$ git push origin 67928c1260078e36d473f2d4a9a23585c7f3ff15:main
To https://github.com/mincho-js/mincho.git
   c62ffe7..67928c1  67928c1260078e36d473f2d4a9a23585c7f3ff15 -> main

@github-actions github-actions bot merged commit 67928c1 into main Jul 24, 2024
7 checks passed
@black7375 black7375 deleted the feature-request-rfc branch August 29, 2024 05:45
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
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant