From 6138a1cf62b11f82bd535649437dd239618628e6 Mon Sep 17 00:00:00 2001 From: neverland Date: Sat, 11 Jan 2025 16:03:43 +0800 Subject: [PATCH] docs: correct some cases --- CODE_OF_CONDUCT.md | 12 ++++++------ README.md | 4 ++-- website/docs/en/community/releases/v1-0.mdx | 2 +- website/docs/en/guide/start/index.mdx | 4 ++-- website/i18n.json | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index df814a23d1..48453c8810 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -45,12 +45,12 @@ or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation +not aligned to this code of conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope -This Code of Conduct applies within all community spaces, and also applies when +This code of conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed @@ -68,7 +68,7 @@ reporter of any incident. ## Enforcement guidelines Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: +the consequences for any action they deem in violation of this code of conduct: ### 1. Correction @@ -86,7 +86,7 @@ of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This +those enforcing the code of conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. @@ -99,7 +99,7 @@ sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. +with those enforcing the code of conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent ban @@ -113,7 +113,7 @@ the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], +This code of conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. diff --git a/README.md b/README.md index 0120a66cee..54e4707fd7 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ The following diagram illustrates the relationship between Rsbuild and other too ## πŸ“š Getting started -To get started with Rsbuild, see the [Quick Start](https://rsbuild.dev/guide/start/quick-start). +To get started with Rsbuild, see the [Quick start](https://rsbuild.dev/guide/start/quick-start). ## πŸ¦€ Links @@ -140,7 +140,7 @@ Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/bl ### Code of conduct -This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details. +This repo has adopted the ByteDance open source code of conduct. Please check [Code of conduct](./CODE_OF_CONDUCT.md) for more details. ## πŸ§‘β€πŸ’» Community diff --git a/website/docs/en/community/releases/v1-0.mdx b/website/docs/en/community/releases/v1-0.mdx index 7e7acabb6f..c7192ed6da 100644 --- a/website/docs/en/community/releases/v1-0.mdx +++ b/website/docs/en/community/releases/v1-0.mdx @@ -80,7 +80,7 @@ As shown, the API style of the Rsbuild plugin is similar to esbuild, it can be d ## How to use 1.0 -- If you haven't used Rsbuild before, you can experience it through the [CodeSandbox example](https://codesandbox.io/p/github/rspack-contrib/rsbuild-codesandbox-example) or refer to the [Quick Start](https://rsbuild.dev/guide/start/quick-start) to use Rsbuild. +- If you haven't used Rsbuild before, you can experience it through the [CodeSandbox example](https://codesandbox.io/p/github/rspack-contrib/rsbuild-codesandbox-example) or refer to the [Quick start](https://rsbuild.dev/guide/start/quick-start) to use Rsbuild. - If you are using Rsbuild 0.7 or earlier, please note that 1.0 includes some breaking changes. You can refer to the [Migrating from 0.x](https://rsbuild.dev/guide/migration/rsbuild-0-x) document to upgrade. - Rsbuild also provides migration guides for projects that use webpack, CRA, Vue CLI, etc. See [Migrate from Existing Projects](https://rsbuild.dev/guide/start/quick-start#migrate-from-existing-projects). diff --git a/website/docs/en/guide/start/index.mdx b/website/docs/en/guide/start/index.mdx index 0464a97c67..14ed1deeac 100644 --- a/website/docs/en/guide/start/index.mdx +++ b/website/docs/en/guide/start/index.mdx @@ -85,12 +85,12 @@ import Step from '@components/Step';