From 1f0599ac198b62a781cd7c6e0a3b956bb15fdc65 Mon Sep 17 00:00:00 2001 From: Banana-J Date: Mon, 7 Aug 2023 20:04:15 +1000 Subject: [PATCH 1/2] update the pull request template (#306) --- .github/pull_request_template.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e3a182057cf2..3f54855ebfaf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,18 +8,20 @@ You description should at least include below key points: ## Types of changes What types of changes does your code introduce to XDC network? -_Put an `x` in the boxes that apply_ +_Put an `✅` in the boxes that apply_ - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation Update (if none of the other choices apply) - [ ] Regular KTLO or any of the maintaince work. e.g code style +- [ ] Other (If none of the above is relevant, please specify reasons below) + ## Impacted Components Which part of the codebase this PR will touch base on, -_Put an `x` in the boxes that apply_ +_Put an `✅` in the boxes that apply_ - [ ] Consensus - [ ] Geth @@ -27,12 +29,13 @@ _Put an `x` in the boxes that apply_ - [ ] Smart Contract - [ ] EVM - [ ] Account -- [ ] Not sure +- [ ] External components +- [ ] Not sure (Please specify below) ## Checklist -_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ +_Put an `✅` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ -- [ ] This PR have sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage +- [ ] This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage - [ ] Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet. - [ ] Tested the backwards compatibility. - [ ] Tested with XDC nodes running this version co-exist with those running the previous version. From c87218ae03bfa055e4d495e9dd87d5506ec592fb Mon Sep 17 00:00:00 2001 From: Banana-J Date: Sun, 13 Aug 2023 09:31:26 +1000 Subject: [PATCH 2/2] Make the pull request template a bit shorter (#308) --- .github/pull_request_template.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3f54855ebfaf..c03200b89570 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,42 +1,33 @@ -## Proposed changes - -Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue(or XIP) or explain it in the pull request. -You description should at least include below key points: -- Proposed version bump. i.e Major, Minor or patch -- Proposed release date to testnet and mainnet +# Proposed changes +Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. ## Types of changes What types of changes does your code introduce to XDC network? _Put an `✅` in the boxes that apply_ -- [ ] Bugfix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Documentation Update (if none of the other choices apply) -- [ ] Regular KTLO or any of the maintaince work. e.g code style -- [ ] Other (If none of the above is relevant, please specify reasons below) - +- [ ] Bugfix +- [ ] New feature +- [ ] Documentation Update or any other KTLO +- [ ] Not sure (Please specify below) ## Impacted Components - Which part of the codebase this PR will touch base on, + _Put an `✅` in the boxes that apply_ - [ ] Consensus -- [ ] Geth +- [ ] Account - [ ] Network +- [ ] Geth - [ ] Smart Contract -- [ ] EVM -- [ ] Account - [ ] External components - [ ] Not sure (Please specify below) ## Checklist -_Put an `✅` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ +_Put an `✅` in the boxes once you have confirmed below actions (or provide reasons on not doing so) that_ - [ ] This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage - [ ] Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet. - [ ] Tested the backwards compatibility. -- [ ] Tested with XDC nodes running this version co-exist with those running the previous version. - [ ] Relevant documentation has been updated as part of this PR \ No newline at end of file