contributing: remove changesets #10574
Conversation
We no longer use changesets to release our software. The changesets still exist for unmaintained code. Removing this from our contributing doc as the maintained software does not use changesets. The releases are on github.
WalkthroughWalkthroughThe recent change to the Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional Context UsedLanguageTool (13)
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 Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (16)
CONTRIBUTING.md (16)
Line range hint
5-5: Consider adding a comma before "and" to improve readability.- **No contribution is too small and all contributions are valued.** + **No contribution is too small, and all contributions are valued.**
Line range hint
22-22: Consider a shorter alternative to avoid wordiness.- In order to contribute, fork the appropriate branch, + To contribute, fork the appropriate branch,
Line range hint
53-53: The official spelling of this programming framework is "Node.js".- * [NodeJS](https://nodejs.org/en/download/) + - [Node.js](https://nodejs.org/en/download/)
Line range hint
56-56: Possible typo: you repeated a word.- * [pnpm](https://pnpm.io/installation) + - [pnpm](https://pnpm.io/installation)
Line range hint
72-72: The official spelling of this programming framework is "Node.js".- ### Install the Correct Version of NodeJS + ### Install the Correct Version of Node.js
Line range hint
92-92: Consider removing "of" to be more concise.- To build all of the [TypeScript packages](./packages), run: + To build all the [TypeScript packages](./packages), run:
Line range hint
106-106: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.- If you want to run an Optimism node OR **if you want to run the integration tests**, you'll need to build the rest of the system. + To run an Optimism node or the integration tests, you'll need to build the rest of the system.
Line range hint
144-144: To elevate your writing, try using a synonym here.- and that can be hard to filter through. + which can be difficult to sift through.
Line range hint
144-144: Consider a shorter alternative to avoid wordiness.- In order to view the logs from a specific service, you can run: + To view logs from a specific service, run:
Line range hint
198-200: A punctuation mark might be missing here.- - **Area labels** ([`A-`][area]): Denote the general area for the related issue or PR changes. - - **Category labels** ([`C-`][category]): Contextualize the type of issue or change. - - **Meta labels** ([`M-`][meta]): These add context to the issues or prs themselves primarily relating to process. - - **Difficulty labels** ([`D-`][difficulty]): Describe the associated implementation's difficulty level. - - **Status labels** ([`S-`][status]): Specify the status of an issue or pr. + - **Area labels** ([`A-`][area]): Denote the general area for the related issue or PR changes. + - **Category labels** ([`C-`][category]): Contextualize the type of issue or change. + - **Meta labels** ([`M-`][meta]): These add context to the issues or PRs themselves, primarily relating to process. + - **Difficulty labels** ([`D-`][difficulty]): Describe the associated implementation's difficulty level. + - **Status labels** ([`S-`][status]): Specify the status of an issue or PR.
Line range hint
225-225: Consider adding a comma for clarity.- When altering label names or deleting labels there are a few things you must be aware of. + When altering label names or deleting labels, there are a few things you must be aware of.
Line range hint
212-212: Heading levels should only increment by one level at a time.- #### Filtering for Work + ### Filtering for Work
Line range hint
52-61: Unordered list style should be consistent.- * [Git](https://git-scm.com/downloads) - * [NodeJS](https://nodejs.org/en/download/) - * [Node Version Manager](https://github.com/nvm-sh/nvm) - * [pnpm](https://pnpm.io/installation) - * [Docker](https://docs.docker.com/get-docker/) - * [Docker Compose](https://docs.docker.com/compose/install/) - * [Go](https://go.dev/dl/) - * [Foundry](https://getfoundry.sh) - * [jq](https://jqlang.github.io/jq/) - * [go-ethereum](https://github.com/ethereum/go-ethereum) + - [Git](https://git-scm.com/downloads) + - [Node.js](https://nodejs.org/en/download/) + - [Node Version Manager](https://github.com/nvm-sh/nvm) + - [pnpm](https://pnpm.io/installation) + - [Docker](https://docs.docker.com/get-docker/) + - [Docker Compose](https://docs.docker.com/compose/install/) + - [Go](https://go.dev/dl/) + - [Foundry](https://getfoundry.sh) + - [jq](https://jqlang.github.io/jq/) + - [go-ethereum](https://github.com/ethereum/go-ethereum)
Line range hint
176-176: Headings should be surrounded by blank lines.- ## Labels + + ## Labels
Line range hint
172-172: Fenced code blocks should be surrounded by blank lines.- ```bash + + ```bash
Line range hint
214-229: Bare URLs used. Consider using markdown links for better readability.- To find tickets available for external contribution, take a look at the https://github.com/ethereum-optimism/optimism/labels/M-community label. - - You can filter by the https://github.com/ethereum-optimism/optimism/labels/D-good-first-issue - label to find issues that are intended to be easy to implement or fix. - - Also, all labels can be seen by visiting the [labels page][labels] + To find tickets available for external contribution, take a look at the [M-community label](https://github.com/ethereum-optimism/optimism/labels/M-community). + + You can filter by the [D-good-first-issue label](https://github.com/ethereum-optimism/optimism/labels/D-good-first-issue) + to find issues that are intended to be easy to implement or fix. + + Also, all labels can be seen by visiting the [labels page](https://github.com/ethereum-optimism/optimism/labels)
We no longer use changesets to release our software. The changesets still exist for unmaintained code. Removing this from our contributing doc as the maintained software does not use changesets. The releases are on github.
Description
We no longer use changesets to release our software.
The changesets still exist for unmaintained code.
Removing this from our contributing doc as the maintained
software does not use changesets. The releases are on github.