From fe85afaf443770425dfe16a3031cd0f535f53473 Mon Sep 17 00:00:00 2001 From: "F. Gold" Date: Tue, 25 Apr 2023 12:42:11 -0700 Subject: [PATCH] Update contributing doc: PRs must be associated with an issue Signed-off-by: F. Gold --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++++-- CONTRIBUTING.md | 1 + 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 213461e..1c14741 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,9 @@ # Description -_Include a summary of the change. If this change fixes an issue, indicate that on the `Fixes` line. Briefly include -relevant context and motivation._ +_Include a summary of the change. +All PRs require an associated issue, even if the fix is trivial, e.g. fixing a typo. +If this change fixes an issue, indicate that on the `Fixes` line. +If this change partially fixes or addresses and issue, indicate that with `Update` in stead of `Fixes`. +Briefly include relevant context and motivation._ Fixes #{issue} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00eebf9..de0b041 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ The build-tooling-for-integrations project team welcomes contributions from the This is a rough outline of what a contributor's workflow looks like: - Create a topic branch from where you want to base your work +- Ensure there is an issue describing the work you'll be doing - Make commits of logical units - Make sure your commit messages are in the proper format (see below) - Push your changes to a topic branch in your fork of the repository