From e53ea0147d16545029e02562921ba6656c741c02 Mon Sep 17 00:00:00 2001 From: Andy McKay Date: Wed, 2 Oct 2019 08:26:13 -0700 Subject: [PATCH] rewrite the pull request template based on feedback --- .github/pull_request_template.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a71d1ab..0138fa5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,19 @@ -Thank you for sending in this pull request. Please make sure you take a look at the [contributing file](CONTRIBUTING.md). Here's a few things for you to consider out on this pull request: +Thank you for sending in this pull request. Please make sure you take a look at the [contributing file](CONTRIBUTING.md). Here's a few things for you to consider in this pull request: - [ ] Include a good description of the workflow. -- [ ] Links to the language or tool will be nice (unless its really obvious). -- [ ] For the `*.yml` file, please include a matching `ci/properties/*.properties.json` file. +- [ ] Links to the language or tool will be nice (unless its really obvious) + +In the workflow and properties files: + +- [ ] Includes a matching `ci/properties/*.properties.json` file. +- [ ] Use title case for the names of workflows and steps, for example "Run tests". +- [ ] The name of CI workflows should only be the name of the language or platform: for example "Go" (not "Go CI" or "Go Build") +- [ ] Include comments in the workflow for any parts that are not obvious or could use clarification. +- [ ] CI workflows should run `push`. +- [ ] Packaging workflows should run on `release` with `types: [created]`. + +Some general notes: + - [ ] Does not use an Action that isn't in the `actions` organization. - [ ] Does not send data to any 3rd party service except for the purposes of installing dependencies. -- [ ] Does use a paid service or product. +- [ ] Does not use a paid service or product.