Templates from Rust RFC #9
Conversation
WalkthroughThe introduction of a structured template for RFCs in the CSS-in-JS library enhances the proposal process for new features and changes. It provides clear guidelines for contributors, fostering clarity and thorough documentation. The template organizes essential sections, making it easier to understand the impact on developers and the library, thereby improving collaboration and evaluation of proposals. Changes
Poem
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
Triggered from #9 by @black7375. Checking if we can fast forward Target branch ( commit 17cf03b6c9602b3ef71e17be18746fbdbe22c6a6 (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <[email protected]>
Date: Sat Jul 13 15:14:14 2024 +0900
Fix: A more intuitive nesting order examplePull request ( commit 73a21ff90a4208be8005daf4e9c4695839a4c408 (pull_request/template)
Author: alstjr7375 <[email protected]>
Date: Sat Jul 20 15:32:37 2024 +0900
Add: Templates from Rust RFC
Refer: https://github.com/rust-lang/rfcs/blob/master/0000-template.mdIt is possible to fast forward |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (8)
000-template.md (8)
3-5: Remove unused link reference definition.The link reference definition for "summary" is not used and can be removed.
- [summary]: #summaryTools
Markdownlint
4-4: Unused link or image reference definition: "summary"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
8-10: Remove unused link reference definition.The link reference definition for "motivation" is not used and can be removed.
- [motivation]: #motivationTools
Markdownlint
9-9: Unused link or image reference definition: "motivation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
15-17: Remove unused link reference definition and fix grammar issues.The link reference definition for "guide-level-explanation" is not used and can be removed. Additionally, consider using the subjunctive mood and adding a comma before "and".
- [guide-level-explanation]: #guide-level-explanation - Explain the proposal as if it was already included in the CSS-in-JS library and you were teaching it to another CSS-in-JS developer. + Explain the proposal as if it were already included in the CSS-in-JS library, and you were teaching it to another CSS-in-JS developer.Tools
Markdownlint
16-16: Unused link or image reference definition: "guide-level-explanation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
28-30: Remove unused link reference definition.The link reference definition for "reference-level-explanation" is not used and can be removed.
- [reference-level-explanation]: #reference-level-explanationTools
Markdownlint
29-29: Unused link or image reference definition: "reference-level-explanation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
39-41: Remove unused link reference definition.The link reference definition for "drawbacks" is not used and can be removed.
- [drawbacks]: #drawbacksTools
Markdownlint
40-40: Unused link or image reference definition: "drawbacks"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
44-46: Remove unused link reference definition and fix grammar issues.The link reference definition for "rationale-and-alternatives" is not used and can be removed. Additionally, consider rewording "in the space of" and adding a comma before "and".
- [rationale-and-alternatives]: #rationale-and-alternatives - Why is this design the best in the space of possible designs? + Why is this design the best among possible designs? - What other designs have been considered and what is the rationale for not choosing them? + What other designs have been considered, and what is the rationale for not choosing them?Tools
Markdownlint
45-45: Unused link or image reference definition: "rationale-and-alternatives"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
52-54: Remove unused link reference definition and fix grammar issues.The link reference definition for "unresolved-questions" is not used and can be removed. Additionally, consider rephrasing to avoid repetitive sentence beginnings.
- [unresolved-questions]: #unresolved-questions - What parts of the design do you expect to resolve through the RFC process before this gets merged? - What parts of the design do you expect to resolve through the implementation of this feature before stabilization? - What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC? + Which parts of the design do you expect to resolve through the RFC process before this gets merged? + Which parts of the design do you expect to resolve through the implementation of this feature before stabilization? + Which related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?Tools
Markdownlint
53-53: Unused link or image reference definition: "unresolved-questions"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
59-61: Remove unused link reference definition and fix spelling issue.The link reference definition for "future-possibilities" is not used and can be removed. Additionally, consider changing "sub-team" to "subteam".
- [future-possibilities]: #future-possibilities - how this all fits into the roadmap for the project and of the relevant sub-team. + how this all fits into the roadmap for the project and of the relevant subteam.Tools
Markdownlint
60-60: Unused link or image reference definition: "future-possibilities"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- 000-template.md (1 hunks)
Additional context used
LanguageTool
000-template.md
[grammar] ~18-~18: You can use the subjunctive mood in this context.
Context: ...lanation Explain the proposal as if it was already included in the CSS-in-JS libra...(SUBJUNCTIVE_MOOD)
[uncategorized] ~18-~18: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...lready included in the CSS-in-JS library and you were teaching it to another CSS-in-...(COMMA_COMPOUND_SENTENCE)
[style] ~47-~47: ‘in the space of’ might be wordy. Consider a shorter alternative.
Context: ...rnatives - Why is this design the best in the space of possible designs? - What other designs ...(EN_WORDINESS_PREMIUM_IN_THE_SPACE_OF)
[uncategorized] ~48-~48: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... What other designs have been considered and what is the rationale for not choosing ...(COMMA_COMPOUND_SENTENCE_2)
[style] ~57-~57: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...of this feature before stabilization? - What related issues do you consider out of s...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~67-~67: This word is normally spelled as one.
Context: ...map for the project and of the relevant sub-team. This is also a good place to "dump id...(EN_COMPOUNDS_SUB_TEAM)
Markdownlint
000-template.md
4-4: Unused link or image reference definition: "summary"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
9-9: Unused link or image reference definition: "motivation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
16-16: Unused link or image reference definition: "guide-level-explanation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
29-29: Unused link or image reference definition: "reference-level-explanation"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
40-40: Unused link or image reference definition: "drawbacks"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
45-45: Unused link or image reference definition: "rationale-and-alternatives"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
53-53: Unused link or image reference definition: "unresolved-questions"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
60-60: Unused link or image reference definition: "future-possibilities"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
Additional comments not posted (1)
000-template.md (1)
1-1: LGTM!The placeholder for the start date is clear and self-explanatory.
|
/fast-forward |
|
Triggered from #9 (comment) by @black7375. Trying to fast forward Target branch ( commit 17cf03b6c9602b3ef71e17be18746fbdbe22c6a6 (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <[email protected]>
Date: Sat Jul 13 15:14:14 2024 +0900
Fix: A more intuitive nesting order examplePull request ( commit 73a21ff90a4208be8005daf4e9c4695839a4c408 (pull_request/template)
Author: alstjr7375 <[email protected]>
Date: Sat Jul 20 15:32:37 2024 +0900
Add: Templates from Rust RFC
Refer: https://github.com/rust-lang/rfcs/blob/master/0000-template.mdFast forwarding $ git push origin 73a21ff90a4208be8005daf4e9c4695839a4c408:main
To https://github.com/mincho-js/working-group.git
17cf03b..73a21ff 73a21ff90a4208be8005daf4e9c4695839a4c408 -> main |
Add the RFCs found in the Rust RFCs.
Summary by CodeRabbit