From 5211a765ef0ebb86329444cfbddd234aa679ee1a Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Thu, 4 Apr 2024 15:26:26 -0700 Subject: [PATCH 1/7] Update RESPONSIBILITIES.md Add code merge responsibility. Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index 438eab67398..fd7e8191684 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -56,6 +56,17 @@ It's our responsibility to ensure the content and code in pull requests are corr - If a pull request is valuable but isn't gaining traction, consider reaching out to fulfill the necessary requirements. This way, the pull request can be merged, even if the work is done by several individuals. - Lastly, strive for progress, not perfection. +### Merging a Pull Request + +It is important that commit messages are helpful in understanding the reasons for a given commit and maintain good commit hygiene by only keeping the relevant information. + +When a PR is going to be merged, our repositories are set to automatically squash the commits into a single commit. This process needs human intervention to produce high quality commit messages, with the following steps to be followed as much as possible: + +- The commit subject is clean and conveys what is being merged. +- The commit body should include the details (if any) about the commit, typically inline with the PR description. +- The commit body should include the 'Signed-Off-By:*' for all committers involved in the change. +- There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail. + ### Triage Open Issues Manage labels, review issues regularly, and triage by labelling them. From 962c397740a4f9097c4b86b1a940a807c631c5f2 Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Mon, 8 Apr 2024 14:29:18 -0700 Subject: [PATCH 2/7] Update RESPONSIBILITIES.md Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index fd7e8191684..b5d286b1a20 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -4,6 +4,7 @@ - [Uphold Code of Conduct](#uphold-code-of-conduct) - [Prioritize Security](#prioritize-security) - [Review Pull Requests](#review-pull-requests) + - [Merging a Pull Request](#merging-a-pull-request) - [Triage Open Issues](#triage-open-issues) - [Automatically Label Issues](#automatically-label-issues) - [Be Responsive](#be-responsive) @@ -60,9 +61,9 @@ It's our responsibility to ensure the content and code in pull requests are corr It is important that commit messages are helpful in understanding the reasons for a given commit and maintain good commit hygiene by only keeping the relevant information. -When a PR is going to be merged, our repositories are set to automatically squash the commits into a single commit. This process needs human intervention to produce high quality commit messages, with the following steps to be followed as much as possible: +Most repositories in [opensearch-project](https://github.com/opensearch-project) are configured to require commits to be squashed into a single commit when merging pull requests. This process needs human intervention to produce high quality commit messages. When merging pull requests, edit merge messages by following these steps as much as possible: -- The commit subject is clean and conveys what is being merged. +- The commit subject should be concise and clearly convey what is being merged. - The commit body should include the details (if any) about the commit, typically inline with the PR description. - The commit body should include the 'Signed-Off-By:*' for all committers involved in the change. - There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail. From 4dae24b18df2b8f6356196885280a3a4e0af5095 Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Tue, 9 Apr 2024 11:33:08 -0700 Subject: [PATCH 3/7] Update RESPONSIBILITIES.md Co-authored-by: Andrew Ross Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index b5d286b1a20..21df08fe6e1 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -61,7 +61,7 @@ It's our responsibility to ensure the content and code in pull requests are corr It is important that commit messages are helpful in understanding the reasons for a given commit and maintain good commit hygiene by only keeping the relevant information. -Most repositories in [opensearch-project](https://github.com/opensearch-project) are configured to require commits to be squashed into a single commit when merging pull requests. This process needs human intervention to produce high quality commit messages. When merging pull requests, edit merge messages by following these steps as much as possible: +Most repositories in [opensearch-project](https://github.com/opensearch-project) are configured to require commits to be squashed into a single commit when merging pull requests. If the pull request contains multiple commits then messages from all commits will be appended into a single message, which usually requires editing to produce a high quality commit message. When merging pull requests, edit commit messages by following these steps as much as possible: - The commit subject should be concise and clearly convey what is being merged. - The commit body should include the details (if any) about the commit, typically inline with the PR description. From 4320ba0d2180b179291baa4c24d6ce93cab60bdc Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Tue, 9 Apr 2024 11:54:55 -0700 Subject: [PATCH 4/7] Update RESPONSIBILITIES.md Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index 21df08fe6e1..bbbb12e3e66 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -65,7 +65,7 @@ Most repositories in [opensearch-project](https://github.com/opensearch-project) - The commit subject should be concise and clearly convey what is being merged. - The commit body should include the details (if any) about the commit, typically inline with the PR description. -- The commit body should include the 'Signed-Off-By:*' for all committers involved in the change. +- The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that they agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). - There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail. ### Triage Open Issues From 14dae6570db5f1a05c8dfca3714656c987e0d6ed Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Tue, 9 Apr 2024 11:57:17 -0700 Subject: [PATCH 5/7] Update RESPONSIBILITIES.md Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index bbbb12e3e66..110865c143c 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -65,7 +65,7 @@ Most repositories in [opensearch-project](https://github.com/opensearch-project) - The commit subject should be concise and clearly convey what is being merged. - The commit body should include the details (if any) about the commit, typically inline with the PR description. -- The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that they agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). +- The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that the contributors agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). - There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail. ### Triage Open Issues From cd369d3e9369fad9dfa71456eab889663b3fea1e Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Tue, 9 Apr 2024 11:58:18 -0700 Subject: [PATCH 6/7] Update RESPONSIBILITIES.md Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index 110865c143c..07d7895747f 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -65,7 +65,7 @@ Most repositories in [opensearch-project](https://github.com/opensearch-project) - The commit subject should be concise and clearly convey what is being merged. - The commit body should include the details (if any) about the commit, typically inline with the PR description. -- The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that the contributors agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). +- The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that all code contributors agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). - There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail. ### Triage Open Issues From 363dda82d873e070cde1ca5c9033675b191dcef1 Mon Sep 17 00:00:00 2001 From: Sandesh Kumar Date: Tue, 9 Apr 2024 12:06:01 -0700 Subject: [PATCH 7/7] Add 50-72 rule for commit subject/message Signed-off-by: Sandesh Kumar --- RESPONSIBILITIES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RESPONSIBILITIES.md b/RESPONSIBILITIES.md index 07d7895747f..cd52b9fd40c 100644 --- a/RESPONSIBILITIES.md +++ b/RESPONSIBILITIES.md @@ -63,8 +63,8 @@ It is important that commit messages are helpful in understanding the reasons fo Most repositories in [opensearch-project](https://github.com/opensearch-project) are configured to require commits to be squashed into a single commit when merging pull requests. If the pull request contains multiple commits then messages from all commits will be appended into a single message, which usually requires editing to produce a high quality commit message. When merging pull requests, edit commit messages by following these steps as much as possible: -- The commit subject should be concise and clearly convey what is being merged. -- The commit body should include the details (if any) about the commit, typically inline with the PR description. +- The commit subject should be concise (ideally within 50 characters) and clearly convey what is being merged. +- The commit body should include the details (if any, and possibly within 72 characters) about the commit, typically inline with the PR description. - The commit body should include the 'Signed-off-by:*' for all committers involved in the change and thereby indicating that all code contributors agree to the [DCO](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). - There need to be a matching 'Signed-Off-By:' line for the `This commit will be authored by *` email address otherwise backport DCO checks will fail.