From 11bff15378fad8716f688f59077b9a50a6b9118d Mon Sep 17 00:00:00 2001 From: Jiaying Wang <42981373+jennijuju@users.noreply.github.com> Date: Mon, 12 Jun 2023 20:43:50 -0400 Subject: [PATCH 1/3] only allow PR to be merged if its all green MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Related Issues & Context During lotus summit in June, 2023, it was reflected that the current lotus merge & release testing flow may have the following bug: - A PR that introduces experimental features, small bug fixes, or updated deps may land in master(dev branch) without being fully tested. -Some Lotus contributors rely on the lotus release flow to cover the testing. However, that code change may land in a production stable release without full testing if the release steward didn't capture it in the release test plan. - This may result in uncaptured regression, bugs, and untested features to be included in a stable release before shipping to users. As a result, we proposed to start only "Hit the merge button when everything is 🟢 ", 🟢 means: - CI is gree. - PR includes context and test plans - lotus maintainers should review the proposed test plans as the PR is open & work with the author to align and finalize on the test plan. - there is proper documentation for new & updated features/configurations - A PR only gets to be merged if all above is 🟢 ## Proposed Changes updated the PR template: - added test plan session - updated the changelog ## Test Plan N/A ## Checklist @lotus-maintainers will only approve the PR if all mandatory boxes below are checked: - [ ] Commits have a clear commit message. - [ ] PR title is in the form of of `: : ` - example: ` fix: mempool: Introduce a cache for valid signatures` - `PR type`: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test - `area`, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps - [ ] (optional) New or updated features/configuration have usage guidelines and/or documentation updates in [Lotus Documentation](https://lotus.filecoin.io). - [ ] CI is green --- .github/pull_request_template.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b6ef5fa3c3e..2f01ff642a8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,23 +1,20 @@ -## Related Issues - +## Related Issues & Context + ## Proposed Changes -## Additional Info - +## Test Plan + ## Checklist -Before you mark the PR ready for review, please make sure that: +@lotus-maintainers will only approve the PR if all boxes below are checked: - [ ] Commits have a clear commit message. - [ ] PR title is in the form of of `: : ` - example: ` fix: mempool: Introduce a cache for valid signatures` - `PR type`: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test - `area`, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps -- [ ] New features have usage guidelines and / or documentation updates in - - [ ] [Lotus Documentation](https://lotus.filecoin.io) - - [ ] [Discussion Tutorials](https://github.com/filecoin-project/lotus/discussions/categories/tutorials) -- [ ] Tests exist for new functionality or change in behavior +- [ ] New or updated features/configuration have usage guidelines and/or documentation updates in [Lotus Documentation](https://lotus.filecoin.io). - [ ] CI is green From e48f27ac9dda8c28ad2dac49b6271aa02aa9f899 Mon Sep 17 00:00:00 2001 From: Jiaying Wang <42981373+jennijuju@users.noreply.github.com> Date: Tue, 28 May 2024 05:41:26 -0400 Subject: [PATCH 2/3] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Friðrik Ásmundsson --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2f01ff642a8..634c1f192fd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@ ## Test Plan - + ## Checklist From c553aa15e243b30081c0c51d42529336e180cda4 Mon Sep 17 00:00:00 2001 From: Jiaying Wang <42981373+jennijuju@users.noreply.github.com> Date: Tue, 28 May 2024 05:42:08 -0400 Subject: [PATCH 3/3] Update pull_request_template.md --- .github/pull_request_template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 634c1f192fd..36f870a4a83 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,5 +16,4 @@ - example: ` fix: mempool: Introduce a cache for valid signatures` - `PR type`: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test - `area`, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps -- [ ] New or updated features/configuration have usage guidelines and/or documentation updates in [Lotus Documentation](https://lotus.filecoin.io). - [ ] CI is green