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: Fix typos in RFC Creation Process #20998

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Conversation

conr2d
Copy link
Contributor

@conr2d conr2d commented Jul 19, 2024

Description

This PR fixes typos in the documentation of RFC Creation Process.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Improved clarity and consistency in the RFC creation process document.
    • Updated section headings and grammar for better readability.
    • Clarified distinctions between RFCs and ADRs and updated status definitions.

@conr2d conr2d requested a review from a team as a code owner July 19, 2024 13:48
Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Walkthrough

Walkthrough

The document PROCESS.md has been revised to enhance clarity, consistency, and professionalism. Key modifications include rephrased instructions, grammatical corrections in section headings, and clearer distinctions between RFCs and ADRs. The status definitions were updated to clarify that one RFC can supersede another RFC, reinforcing the document's focus. Overall, these changes aim to improve readability without altering the fundamental content or structure.

Changes

Files Change Summary
docs/rfc/PROCESS.md Textual revisions for clarity and consistency, including rephrased instructions, grammatical corrections, and updated status definitions regarding RFCs and ADRs.

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

@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: 9

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b065219 and 7fc9194.

Files selected for processing (1)
  • docs/rfc/PROCESS.md (2 hunks)
Additional context used
Path-based instructions (1)
docs/rfc/PROCESS.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool
docs/rfc/PROCESS.md

[misspelling] ~9-~9: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...quest to propose a new RFC. ## What is a RFC? A RFC is a sort of async whiteboa...

(EN_A_VS_AN)


[misspelling] ~10-~10: Use “An” instead of ‘A’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... propose a new RFC. ## What is a RFC? A RFC is a sort of async whiteboarding se...

(EN_A_VS_AN)


[style] ~11-~11: ‘make a decision’ might be wordy. Consider a shorter alternative.
Context: ... a distributed team to come together to make a decision. Currently, the Cosmos SDK team and con...

(EN_WORDINESS_PREMIUM_MAKE_A_DECISION)


[uncategorized] ~11-~11: Possible missing comma found.
Context: ...ts working groups to have a synchronous discussion and a RFC can be used to capture the di...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~11-~11: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ps to have a synchronous discussion and a RFC can be used to capture the discussi...

(EN_A_VS_AN)


[misspelling] ~17-~17: Use “An” instead of ‘A’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...C creation is an iterative process. A RFC is meant as a distributed collabora...

(EN_A_VS_AN)


[misspelling] ~21-~21: Use “An” instead of ‘A’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...of existing Issues or a discussion. 2. A RFC doesn't have to arrive to main wi...

(EN_A_VS_AN)


[uncategorized] ~31-~31: Possible missing comma found.
Context: ...ion. If there is a working group on the proposal there is no need to have a RFC as there...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~31-~31: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...n the proposal there is no need to have a RFC as there is synchronous whiteboardi...

(EN_A_VS_AN)


[uncategorized] ~51-~51: Loose punctuation mark.
Context: ... ABANDONED ``` * DRAFT: [optional] a RFC which is work in progr...

(UNLIKELY_OPENING_PUNCTUATION)


[misspelling] ~51-~51: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... ABANDONED ``` * DRAFT: [optional] a RFC which is work in progress, not bein...

(EN_A_VS_AN)


[uncategorized] ~52-~52: Loose punctuation mark.
Context: ... a Draft Pull Request form. * PROPOSED: a RFC covering a full solution architec...

(UNLIKELY_OPENING_PUNCTUATION)


[misspelling] ~52-~52: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... Draft Pull Request form. * PROPOSED: a RFC covering a full solution architectu...

(EN_A_VS_AN)


[uncategorized] ~53-~53: Loose punctuation mark.
Context: .... * LAST CALL <date for the last call>: [optional] clearly notify that we are c...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~53-~53: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...Cosmos SDK maintainers) has been reached and we still want to give it time to let th...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...community react or analyze. * ACCEPTED: RFC which will represent a currently im...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...mented architecture design. * REJECTED: RFC can go from PROPOSED or ACCEPTED to...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...rs decides so. * SUPERSEDED by RFC-xxx: RFC which has been superseded by a new ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...n superseded by a new RFC. * ABANDONED: the RFC is no longer pursued by the ori...

(UNLIKELY_OPENING_PUNCTUATION)

Additional comments not posted (2)
docs/rfc/PROCESS.md (2)

5-5: Correct the article usage.

Change "a RFC" to "an RFC" for grammatical correctness.

- 3. Make sure the context and solution are clear and well-documented.
+ 3. Make sure the context and a solution are clear and well-documented.

Likely invalid or redundant comment.


4-4: Correct the article usage.

Change "a RFC" to "an RFC" for grammatical correctness.

- 2. Create a draft Pull Request if you want to get early feedback.
+ 2. Create a draft Pull Request if you want to get an early feedback.

Likely invalid or redundant comment.

docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
docs/rfc/PROCESS.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7fc9194 and fbea172.

Files selected for processing (1)
  • docs/rfc/PROCESS.md (2 hunks)
Additional context used
Path-based instructions (1)
docs/rfc/PROCESS.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool
docs/rfc/PROCESS.md

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...w GitHub Issue, be a result of existing Issues or a discussion. 2. An RFC doesn't hav...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~29-~29: A comma might be missing here.
Context: ...d. 6. If there is consensus and enough feedback then the RFC can be accepted. > Note: ...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~51-~51: Loose punctuation mark.
Context: ... ABANDONED ``` * DRAFT: [optional] an RFC which is work in prog...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~52-~52: Loose punctuation mark.
Context: ... a Draft Pull Request form. * PROPOSED: an RFC covering a full solution archite...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~53-~53: Loose punctuation mark.
Context: .... * LAST CALL <date for the last call>: [optional] clearly notify that we are c...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...community react or analyze. * ACCEPTED: RFC which will represent a currently im...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~54-~54: Possible missing comma found.
Context: ...mmunity react or analyze. * ACCEPTED: RFC which will represent a currently implem...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...mented architecture design. * REJECTED: RFC can go from PROPOSED or ACCEPTED to...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...rs decides so. * SUPERSEDED by RFC-xxx: RFC which has been superseded by a new ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...n superseded by a new RFC. * ABANDONED: the RFC is no longer pursued by the ori...

(UNLIKELY_OPENING_PUNCTUATION)

Additional comments not posted (10)
docs/rfc/PROCESS.md (10)

4-4: Approved: Improved readability.

The change from "get an early feedback" to "get early feedback" enhances readability.


5-5: Approved: Corrected grammatical errors.

The change from "context and a solution is clear" to "context and solution are clear" corrects grammatical errors and improves clarity.


11-11: Approved: Corrected article usage.

The change from "A RFC" to "An RFC" corrects the article usage.


13-13: Approved: Corrected article usage.

The change from "A RFC" to "An RFC" corrects the article usage.


17-17: Approved: Corrected article usage.

The change from "A RFC" to "An RFC" corrects the article usage.


19-19: Approved: Corrected article usage.

The change from "A RFC" to "An RFC" corrects the article usage.

Tools
LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...w GitHub Issue, be a result of existing Issues or a discussion. 2. An RFC doesn't hav...

(AI_HYDRA_LEO_MISSING_COMMA)


25-25: Approved: Improved readability.

The addition of a comma before "then" improves readability and correctness.


31-31: Approved: Corrected article usage and improved readability.

The change from "A RFC" to "An RFC" and the addition of a comma before "as" corrects the article usage and improves readability.


44-44: Approved: Clarified document focus.

The change from "ADRs" to "RFCs" clarifies the document's focus on RFCs.


51-57: Approved: Corrected article usage.

The changes from "A RFC" to "An RFC" in multiple places correct the article usage.

Tools
LanguageTool

[uncategorized] ~51-~51: Loose punctuation mark.
Context: ... ABANDONED ``` * DRAFT: [optional] an RFC which is work in prog...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~52-~52: Loose punctuation mark.
Context: ... a Draft Pull Request form. * PROPOSED: an RFC covering a full solution archite...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~53-~53: Loose punctuation mark.
Context: .... * LAST CALL <date for the last call>: [optional] clearly notify that we are c...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...community react or analyze. * ACCEPTED: RFC which will represent a currently im...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~54-~54: Possible missing comma found.
Context: ...mmunity react or analyze. * ACCEPTED: RFC which will represent a currently implem...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...mented architecture design. * REJECTED: RFC can go from PROPOSED or ACCEPTED to...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...rs decides so. * SUPERSEDED by RFC-xxx: RFC which has been superseded by a new ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...n superseded by a new RFC. * ABANDONED: the RFC is no longer pursued by the ori...

(UNLIKELY_OPENING_PUNCTUATION)

@tac0turtle tac0turtle added this pull request to the merge queue Jul 19, 2024
Merged via the queue into cosmos:main with commit b551384 Jul 19, 2024
69 of 70 checks passed
@conr2d conr2d deleted the fix-typos branch July 20, 2024 04:41
alpe added a commit that referenced this pull request Jul 23, 2024
* main: (48 commits)
  build(deps): add missing replaces and remove unnecessary ones (#21033)
  build(deps): Bump bufbuild/buf-setup-action from 1.34.0 to 1.35.0 (#21028)
  chore: fix some comments for struct field (#21027)
  chore(x): replace `fmt.Errorf` without parameters with `errors.New` (#21032)
  chore: fix errors reported by running `make lint` (#21015)
  ci: skip spelling check in go.mod/go.sum (#21021)
  chore(all)!: use gogoproto/any instead of codec/types/any (#21013)
  chore(server/v2/cometbft): ensure consistent dash-case in app.toml (#21018)
  docs(server): wrong function comments (#21017)
  refactor(storev2): update snapshot manager and migration manager tests (#20441)
  feat(server/v2/cometbft): config (#20989)
  refactor: set `help` as default target of Makefile (#21011)
  fix(simapp): duplicated import (#21014)
  chore(docs): fix functions and struct comments (#21010)
  fix(simapp/v2): panic with testnet init-files command (#21012)
  fix: make help won't work (#21005)
  fix: NewIntegrationApp does not write default genesis to state (#21006)
  chore(x/staking,x/upgrade): replace `fmt.Errorf` without parameters with `errors.New` (#21004)
  chore: prepare depinject 1.0.0 (#21001)
  docs: Fix typos in RFC Creation Process (#20998)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants