+
Skip to content
This repository was archived by the owner on Aug 31, 2023. It is now read-only.

chore: remove changelog line and documentation parts #4610

Merged
merged 2 commits into from
Jun 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,3 @@
## Test Plan

<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output. -->

## Changelog

<!--
Read the following paragraph for more information: https://github.com/rome/tools/blob/main/CONTRIBUTING.md#changelog

Tick the checkbox if your PR requires a new line in the changelog.
-->

- [ ] The PR requires a changelog line

## Documentation

<!--

Read the following paragraph for more information: https://github.com/rome/tools/blob/main/CONTRIBUTING.md#documentation

Tick the checkboxes if your PR requires some documentation, and if you will follow up with that

-->

- [ ] The PR requires documentation
- [ ] I will create a new PR to update the documentation
13 changes: 2 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ Please use the template provided.

#### Changelog

If the PR you're about to open is a bugfix/feature around Rome, you should add a new line to the `CHANGELOG.md`.
If the PR you're about to open is a bugfix/feature around Rome, you can add a new line to the `CHANGELOG.md`, but it's not mandatory.

At the top of the file you will see a `[Unreleased]` section. The headings divide the sections by "feature", make sure
to add a new bullet point.
Expand Down Expand Up @@ -273,16 +273,7 @@ how the new formatting changes, and so on.
#### Documentation

If your PR requires some update on the website (new features, breaking changes, etc.), you should create a new PR once the previous PR is successfully merged.

Go to the issues section and check the pinned issues.
You will find a _**pinned issue**_ that starts with "Documentation and Focus". Inside, you will find the details of:
- the name of the branch where to point the PR that updates the documentation;
- the PR that we will merge when the release is ready;

If you can't create a new PR, please let the team know.
The template should help to give all the information to the team.

Here are some other scripts that you might find useful.
When adding new features, the documentation should be part of a new PR, which will be merged right before the release.

#### Magic comments

Expand Down
7 changes: 7 additions & 0 deletions editors/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,10 @@ Enables Rome to handle renames in the workspace (experimental).

Disables formatting, linting, and syntax errors for projects without a `rome.json` file. Requires Rome 12 or newer.
Enabled by default.

## Versioning

We follow the specs suggested by [the official documentation](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions):

Odd minor versions are dedicated to pre-releases, e.g. `*.5.*` .
Even minor versions are dedicated to official releases, e.g. `*.6.*`.
7 changes: 7 additions & 0 deletions website/src/pages/vscode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,10 @@ Enables Rome to handle renames in the workspace (experimental).

Disables formatting, linting, and syntax errors for projects without a `rome.json` file. Requires Rome 12 or newer.
Enabled by default.

## Versioning

We follow the specs suggested by [the official documentation](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions):

Odd minor versions are dedicated to pre-releases, e.g. `*.5.*` .
Even minor versions are dedicated to official releases, e.g. `*.6.*`.
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载