From f6e5d1ea512ea23eef91bc6aba5f368c68f9a539 Mon Sep 17 00:00:00 2001 From: Angelica Willianto <78342026+angelicawill@users.noreply.github.com> Date: Fri, 19 Apr 2024 17:18:40 +0800 Subject: [PATCH 1/2] docs: read information about Github commit signature --- .github/CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 255ab1f..f9fbcc5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -126,6 +126,15 @@ Thus, the names of the PRs must: - feat: modified door function ``` +## Commit Signature Verification + +For the security and integrity of our project, we require all contributors to sign their commits. While we recommend using SSH for its simplicity, you may also use GPG or other methods. + +For detailed instructions on how to sign your commits with SSH, GPG, or another method, and to understand why commit signing is crucial for our project's security, please refer to [GitHub's documentation on commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). + +> [!NOTE] +>We recommend signing commits using an [SSH key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification) for a straightforward setup and verification process. Ensure your Git version supports SSH signature verification (Git 2.34 or later). + ## Requesting Review Once your PR is ready, assign reviewers and mark it as "ready to review". But before that, make sure to report the time you have spent on the PR. From fdb5b0fad91dbdad5205852264e358c2b92df8e5 Mon Sep 17 00:00:00 2001 From: Vadim <1125014+zolotokrylin@users.noreply.github.com> Date: Fri, 19 Apr 2024 16:51:04 +0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f9fbcc5..5c7b2bb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -54,6 +54,15 @@ All PRs, whether for source code, design or copy changes, must comply with our P > [!WARNING] > PRs that do not correspond to the following criteria are usually rejected. +## Commit Signature Verification + +For the security and integrity of our project, we require all contributors to sign their commits. +For detailed instructions on why and how to sign your commits refer to [GitHub's documentation on commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). + +> [!Note] +> We recommend signing commits using an [SSH key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification). Ensure your Git version supports SSH signature verification (Git 2.34 or later). + + ## Scoping > [!NOTE] @@ -126,15 +135,6 @@ Thus, the names of the PRs must: - feat: modified door function ``` -## Commit Signature Verification - -For the security and integrity of our project, we require all contributors to sign their commits. While we recommend using SSH for its simplicity, you may also use GPG or other methods. - -For detailed instructions on how to sign your commits with SSH, GPG, or another method, and to understand why commit signing is crucial for our project's security, please refer to [GitHub's documentation on commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). - -> [!NOTE] ->We recommend signing commits using an [SSH key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification) for a straightforward setup and verification process. Ensure your Git version supports SSH signature verification (Git 2.34 or later). - ## Requesting Review Once your PR is ready, assign reviewers and mark it as "ready to review". But before that, make sure to report the time you have spent on the PR.