From abbdb987c60e70e41216b3329a38ffea4df6f8ff Mon Sep 17 00:00:00 2001 From: Emanuele Stoppa Date: Sat, 24 Jun 2023 11:55:26 +0100 Subject: [PATCH 1/2] chore: remove changelog line and documentation parts --- .github/PULL_REQUEST_TEMPLATE.md | 23 ----------------------- CONTRIBUTING.md | 13 ++----------- editors/vscode/README.md | 7 +++++++ website/src/pages/vscode.mdx | 7 +++++++ 4 files changed, 16 insertions(+), 34 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a161aaf4c8d..5dff0d4a201 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,26 +17,3 @@ ## Test Plan - -## Changelog - - - -- [ ] The PR requires a changelog line - -## Documentation - - - -- [ ] The PR requires documentation -- [ ] I will create a new PR to update the documentation diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3dc7e8f9a5..5688a758198 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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 addition new features, the documentation should be part of a new PR, which will be merged right before the release. #### Magic comments diff --git a/editors/vscode/README.md b/editors/vscode/README.md index ba0ae864121..716991f4a9b 100644 --- a/editors/vscode/README.md +++ b/editors/vscode/README.md @@ -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.*`. diff --git a/website/src/pages/vscode.mdx b/website/src/pages/vscode.mdx index aec01f8817d..dbdd6bc2641 100644 --- a/website/src/pages/vscode.mdx +++ b/website/src/pages/vscode.mdx @@ -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.*`. From c3cff05545840468a49c3f9ec21396e623b74341 Mon Sep 17 00:00:00 2001 From: Emanuele Stoppa Date: Sat, 24 Jun 2023 12:45:43 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: Victorien ELVINGER --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5688a758198..e942472f385 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -273,7 +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. -When addition new features, the documentation should be part of a new PR, which will be merged right before the release. +When adding new features, the documentation should be part of a new PR, which will be merged right before the release. #### Magic comments