diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 35bfb44..d1b6bfb 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,17 @@ -Thank you for sending in this pull request. Please make sure you take a look at the [contributing file](https://github.com/actions/starter-workflows/blob/master/CONTRIBUTING.md). Here's a few things for you to consider in this pull request: +This repository contains configuration for what users see when they click on the `Actions` tab. -- [ ] Include a good description of the workflow. -- [ ] Links to the language or tool will be nice (unless its really obvious) +It is not: +* A playground to try out scripts +* A place for you to create a workflow for your repository + +-- + +Thank you for sending in this pull request. Please make sure you take a look at the [contributing file](https://github.com/actions/starter-workflows/blob/master/CONTRIBUTING.md). Here's a few things for you to consider in this pull request. + +Please **add to this description** at the bottom :point_down: + +- [ ] A good description of the workflow at the bottom of this page. +- [ ] Some links to the language or tool will be nice (unless its really obvious) In the workflow and properties files: @@ -13,14 +23,12 @@ In the workflow and properties files: - [ ] 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 on `push` to `branches: [ master ]` and `pull_request` to `branches: [ master ]`. - - Packaging workflows should run on `release` with `types: [ created ]`. +- [ ] Packaging workflows should run on `release` with `types: [ created ]`. Some general notes: - [ ] This workflow must only use actions that are produced by GitHub, [in the `actions` organization](https://github.com/actions), **or** - - This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be [published to the GitHub Marketplace](https://github.com/marketplace?type=actions). Workflows using these actions must reference the action using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file: +- [ ] This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be [published to the GitHub Marketplace](https://github.com/marketplace?type=actions). Workflows using these actions must reference the action using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file: ``` # This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by