From c8f843bea4aa1f18780a31acc42c070d834595a0 Mon Sep 17 00:00:00 2001 From: "Xuan (Sean) Hu" Date: Mon, 8 Jul 2024 18:07:26 +0800 Subject: [PATCH] docs: use absolute url in docs (#649) --- docs/development/commit.md | 2 +- docs/development/setup-dev-env.md | 2 +- docs/management/release.md | 2 +- template/docs/development/commit.md | 2 +- template/docs/development/setup-dev-env.md | 2 +- template/docs/management/release.md.jinja | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/development/commit.md b/docs/development/commit.md index dc30dca9..dbc7d281 100644 --- a/docs/development/commit.md +++ b/docs/development/commit.md @@ -43,7 +43,7 @@ A "breaking change" refers to any modification that disrupts the existing functi ## Commit in Development Branches While the commit convention seems strict, we aim for flexibility during the development phase. -By adhering to the , all changes should be introduced via pull/merge requests. +By adhering to the , all changes should be introduced via pull/merge requests. Using the squash merge strategy, the emphasis is primarily on the title of pull/merge requests. In this way, individual commit within development branches does not need to strictly adhere to the commit convention. diff --git a/docs/development/setup-dev-env.md b/docs/development/setup-dev-env.md index 7c6a42a2..48e77040 100644 --- a/docs/development/setup-dev-env.md +++ b/docs/development/setup-dev-env.md @@ -27,4 +27,4 @@ This command will accomplish the following tasks: - Install the project in editable mode. - Install git hook scripts for `pre-commit`. -To speed up the setup process in certain scenarios, you may find helpful. +To speed up the setup process in certain scenarios, you may find helpful. diff --git a/docs/management/release.md b/docs/management/release.md index 554d2440..90ff9de9 100644 --- a/docs/management/release.md +++ b/docs/management/release.md @@ -1,6 +1,6 @@ # Release Process -With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for . Besides, adhering to the [Commit Convention](../development/commit.md#commit-message-pattern) is strongly recommended to ensure the release process works as expected. +With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for . Besides, adhering to the is strongly recommended to ensure the release process works as expected. ## Release Configuration diff --git a/template/docs/development/commit.md b/template/docs/development/commit.md index dc30dca9..dbc7d281 100644 --- a/template/docs/development/commit.md +++ b/template/docs/development/commit.md @@ -43,7 +43,7 @@ A "breaking change" refers to any modification that disrupts the existing functi ## Commit in Development Branches While the commit convention seems strict, we aim for flexibility during the development phase. -By adhering to the , all changes should be introduced via pull/merge requests. +By adhering to the , all changes should be introduced via pull/merge requests. Using the squash merge strategy, the emphasis is primarily on the title of pull/merge requests. In this way, individual commit within development branches does not need to strictly adhere to the commit convention. diff --git a/template/docs/development/setup-dev-env.md b/template/docs/development/setup-dev-env.md index 7c6a42a2..48e77040 100644 --- a/template/docs/development/setup-dev-env.md +++ b/template/docs/development/setup-dev-env.md @@ -27,4 +27,4 @@ This command will accomplish the following tasks: - Install the project in editable mode. - Install git hook scripts for `pre-commit`. -To speed up the setup process in certain scenarios, you may find helpful. +To speed up the setup process in certain scenarios, you may find helpful. diff --git a/template/docs/management/release.md.jinja b/template/docs/management/release.md.jinja index 06e21d0f..5f6a0c63 100644 --- a/template/docs/management/release.md.jinja +++ b/template/docs/management/release.md.jinja @@ -1,6 +1,6 @@ # Release Process -With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for . Besides, adhering to the [Commit Convention](../development/commit.md#commit-message-pattern) is strongly recommended to ensure the release process works as expected. +With the integration of [semantic-release](https://github.com/semantic-release/semantic-release), the release process is fully automated. To enable this, follow the settings for . Besides, adhering to the is strongly recommended to ensure the release process works as expected. ## Release Configuration