From 5defa8c242dc81e379a2f12d6e6787b839249552 Mon Sep 17 00:00:00 2001 From: loloicci Date: Thu, 23 Dec 2021 15:35:09 +0900 Subject: [PATCH 1/5] feat: rewrite issue template and move PR template --- .github/ISSUE_TEMPLATE/bug-report.md | 20 +++--------- .github/ISSUE_TEMPLATE/feature-request.md | 14 +++----- .github/PULL_REQUEST_TEMPLATE.md | 40 ++++++++++------------- PULL_REQUEST_TEMPLATE.md | 22 ------------- 4 files changed, 27 insertions(+), 69 deletions(-) delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 369cd676cb..25f4eea8f6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,31 +1,21 @@ --- -name: Bug Report +name: Bug Report about: Create a report to help us squash bugs! - --- - - - ## Summary of Bug - ## Version - ## Steps to Reproduce - ____ diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 324ab9a8ab..0c05d846f7 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,29 +1,25 @@ --- name: Feature Request about: Create a proposal to request a feature - --- - ## Summary - ## Problem Definition - - ## Proposal - ____ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 01cfd4f0e0..6bf4f0797a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,29 +1,23 @@ - + ## Description - - - + closes: #XXXX ---- +## Motivation and context + + + +## How has this been tested? + + + -Before we can merge this PR, please make sure that all the following items have been -checked off. If any of the checklist items are not applicable, please leave them but -write a little note why. +## Screenshots (if appropriate): -- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) -- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. -- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). -- [ ] Wrote unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) -- [ ] Updated relevant documentation (`docs/`) or specification (`x//spec/`) -- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). -- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` -- [ ] Re-reviewed `Files changed` in the Github PR explorer -- [ ] Review `Codecov Report` in the comment section below once CI passes +## Checklist: + + +- [ ] I followed the [contributing guidelines](./CONTRIBUTING.md). +- [ ] I have updated the documentation accordingly. +- [ ] I have added tests to cover my changes. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0bd6becdaa..0000000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,22 +0,0 @@ - - -## Description - - -## Motivation and context - - - -## How has this been tested? - - - - -## Screenshots (if appropriate): - -## Checklist: - - -- [ ] I followed the [contributing guidelines](./CONTRIBUTING.md). -- [ ] I have updated the documentation accordingly. -- [ ] I have added tests to cover my changes. From b5306ebdc226eb71a57d9fef919c85d34edb5d4f Mon Sep 17 00:00:00 2001 From: loloicci Date: Thu, 23 Dec 2021 18:03:57 +0900 Subject: [PATCH 2/5] feat: add checkboxes to PR template --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6bf4f0797a..df07070b33 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,5 +19,7 @@ closes: #XXXX - [ ] I followed the [contributing guidelines](./CONTRIBUTING.md). -- [ ] I have updated the documentation accordingly. +- [ ] I have added a relevant changelog to `CHANGELOG.md` - [ ] I have added tests to cover my changes. +- [ ] I have updated the documentation accordingly. +- [ ] I have updated API documentation (client/docs/swagger-ui/swagger.yaml). From 2c8aac2180932361f7ff4ffb38a06d13f7a56b29 Mon Sep 17 00:00:00 2001 From: loloicci Date: Thu, 23 Dec 2021 18:09:27 +0900 Subject: [PATCH 3/5] feat: add comment about checkbox to PR template --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index df07070b33..9d98a8b897 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,6 +17,7 @@ closes: #XXXX ## Checklist: + - [ ] I followed the [contributing guidelines](./CONTRIBUTING.md). - [ ] I have added a relevant changelog to `CHANGELOG.md` From 537b3deeb7e13d2792556c3c0cd748f6b0a00501 Mon Sep 17 00:00:00 2001 From: loloicci Date: Fri, 7 Jan 2022 12:17:01 +0900 Subject: [PATCH 4/5] doc: add code of conduct to PR template --- .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 9d98a8b897..c279ffa13c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,7 @@ closes: #XXXX -- [ ] I followed the [contributing guidelines](./CONTRIBUTING.md). +- [ ] I followed the [contributing guidelines](https://github.com/line/lbm-sdk/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/line/lbm-sdk/blob/main/CODE_OF_CONDUCT.md). - [ ] I have added a relevant changelog to `CHANGELOG.md` - [ ] I have added tests to cover my changes. - [ ] I have updated the documentation accordingly. From bece8d53c5fb4746a6a247e872241d8dc68dfdfb Mon Sep 17 00:00:00 2001 From: loloicci Date: Mon, 17 Jan 2022 14:55:26 +0900 Subject: [PATCH 5/5] doc: highlight swagger file path in PR template --- .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 c279ffa13c..fee462c6c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,4 +23,4 @@ closes: #XXXX - [ ] I have added a relevant changelog to `CHANGELOG.md` - [ ] I have added tests to cover my changes. - [ ] I have updated the documentation accordingly. -- [ ] I have updated API documentation (client/docs/swagger-ui/swagger.yaml). +- [ ] I have updated API documentation `client/docs/swagger-ui/swagger.yaml`