Add usage comments to bug and PR templates

to tell users to remove unncesary parts before submitting.
This commit is contained in:
Juan Luis Baptiste 2022-05-13 10:05:01 -05:00
parent 7a9b9513a7
commit 7d8086dd01
2 changed files with 6 additions and 1 deletions

View File

@ -6,12 +6,14 @@ labels: ''
assignees: '' assignees: ''
--- ---
<!-- BEFORE SUBMITTING YOUR PR, PLEASE REMOVE THIS TEXT -->
<!-- REMOVE START -->
**Reporting a bug** **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. 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_. Also be sure you are using the latest image by doing _docker pull juanluisbaptiste/postfix:latest_.
<!-- REMOVE END -->
**Please include the contents of:** **Please include the contents of:**

View File

@ -1,3 +1,5 @@
<!-- BEFORE SUBMITTING YOUR PR, PLEASE REMOVE THIS TEXT -->
<!-- REMOVE START -->
# Creating a Pull Request # 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: 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 `feat:`, and it will trigger a minor version bump.
* Prefix with `fix`:, and it will trigger a patch 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. * Prefix with `BREAKING CHANGE:`, and it will trigger a major version bump.
<!-- REMOVE END -->
## Description of the change ## Description of the change
<!--Please be very clear on the intention of the modifications included in the pull request.--> <!--Please be very clear on the intention of the modifications included in the pull request.-->