From 7d8086dd01cb52d6b6a05e047ea19e412d99ba45 Mon Sep 17 00:00:00 2001 From: Juan Luis Baptiste Date: Fri, 13 May 2022 10:05:01 -0500 Subject: [PATCH] Add usage comments to bug and PR templates to tell users to remove unncesary parts before submitting. --- .github/ISSUE_TEMPLATE/bug_report.md | 4 +++- .github/pull_request_template.md | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c7fe860..792611a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,12 +6,14 @@ labels: '' assignees: '' --- - + + **Reporting a bug** First of all, this is **not** a problem reporting forum, only report if you are pretty sure what you are experiencing is a bug with this image, not a configuration issue, for that you can use the [Github discussions section](https://github.com/juanluisbaptiste/docker-postfix/discussions) and we will do our best to help you to figure out what's going on with your setup. Also be sure you are using the latest image by doing _docker pull juanluisbaptiste/postfix:latest_. + **Please include the contents of:** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e623af5..b12247f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,5 @@ + + # Creating a Pull Request We use github actions to do automatic [semantic versioning](https://github.com/semantic-release/semantic-release), so please use the following nomenclature for the commit message according to the type of change: @@ -5,6 +7,7 @@ We use github actions to do automatic [semantic versioning](https://github.com/s * Prefix with `feat:`, and it will trigger a minor version bump. * Prefix with `fix`:, and it will trigger a patch version bump. * Prefix with `BREAKING CHANGE:`, and it will trigger a major version bump. + ## Description of the change