pmb-pf/.github/pull_request_template.md
Juan Luis Baptiste 7d8086dd01 Add usage comments to bug and PR templates
to tell users to remove unncesary parts before submitting.
2022-05-13 10:05:01 -05:00

2.1 KiB

Creating a Pull Request

We use github actions to do automatic semantic versioning, so please use the following nomenclature for the commit message according to the type of change:

  • 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

Motivation and Context

How Has This Been Tested?

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (adding or updating documentation)

Checklist:

  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • My change adds a new configuration variable and I have updated the .env.example file accordingly.

And lastly, many thanks for taking your time to help us improve this project !