From 3b249705dc93a8f8fee8ff5e89fcae7faae29a5f Mon Sep 17 00:00:00 2001 From: Avelino Date: Thu, 15 Jul 2021 07:11:22 -0300 Subject: [PATCH] Update and rename PULL_REQUEST_TEMPLATE.md to PULL_REQUEST_TEMPLATE.yaml --- .github/PULL_REQUEST_TEMPLATE.md | 24 --------------- .github/PULL_REQUEST_TEMPLATE.yaml | 47 ++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 24 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.yaml diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a096b5bb..00000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,24 +0,0 @@ -Please check if what you want to add to `awesome-go` list meets [quality standards](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standards) before sending pull request. Thanks! - -**Please provide package links to:** - -- github.com repo: -- pkg.go.dev: -- goreportcard.com: -- coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), [gocover](http://gocover.io/) etc.) - - -Very good coverage - -**Note**: that new categories can be added only when there are 3 packages or more. - -**Make sure that you've checked the boxes below before you submit PR:** -- [ ] I have added my package in alphabetical order. -- [ ] I have an appropriate description with correct grammar. -- [ ] I know that this package was not listed before. -- [ ] I have added pkg.go.dev link to the repo and to my pull request. -- [ ] I have added coverage service link to the repo and to my pull request. -- [ ] I have added goreportcard link to the repo and to my pull request. -- [ ] I have read [Contribution guidelines](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#contribution-guidelines), [maintainers note](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#maintainers) and [Quality standard](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standards). - -Thanks for your PR, you're awesome! :+1: diff --git a/.github/PULL_REQUEST_TEMPLATE.yaml b/.github/PULL_REQUEST_TEMPLATE.yaml new file mode 100644 index 00000000..7d8d0ca8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.yaml @@ -0,0 +1,47 @@ +description: | + Please check if what you want to add to `awesome-go` list meets [quality standards](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standards) before sending pull request. Thanks! + **Note**: that new categories can be added only when there are 3 packages or more. + Thanks for your PR, you're awesome! :+1: +body: + - type: input + id: repo + attributes: + label: repo or link + description: github.com, gitlab.com, etc + placeholder: ex. github.com/avelino/... + validations: + required: true + - type: input + id: pkgdev + attributes: + label: pkg.go.dev + placeholder: ex. github.com/you-username/project-name + validations: + required: false + - type: input + id: goreportcard + attributes: + label: goreportcard.com + placeholder: ex. goreportcard.com/github.com/you-username/project-name + validations: + required: false + - type: input + id: coverage + attributes: + label: coverage link + placeholder: coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), [gocover](http://gocover.io/) etc.) + validations: + required: false + - type: checkboxes + attributes: + label: Make sure that you've checked the boxes below before you submit PR + description: not every repository (project) will fit into every option, but most projects should + options: + - label: I have added my package in alphabetical order. + - label: I have an appropriate description with correct grammar. + - label: I know that this package was not listed before. + - label: I have added pkg.go.dev link to the repo and to my pull request. + - label: I have added coverage service link to the repo and to my pull request. + - label: I have added goreportcard link to the repo and to my pull request. + - label: I have read [Contribution guidelines](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#contribution-guidelines), [maintainers note](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#maintainers) and [Quality standard](https://github.com/avelino/awesome-go/blob/master/CONTRIBUTING.md#quality-standards). + required: true