Skip to content

Commit

Permalink
docs: FORMS-1450 update the PR template (bcgov#1487)
Browse files Browse the repository at this point in the history
* docs: FORMS-1450 update the PR template

Working on documentation for all things PR and using a commit body to improve my commits so I can document the process

* docs: FORMS-1450 clean up the title description

Small update to use a real-world example for the title

* docs: FORMS-1450 remove markdown from title comment

Removed the markdown from the comment, since it will never be rendered.

* revert: FORMS-1450 switch type back to individual comments

Realized that some people just might be uncommenting the type, where my way of working is to delete everything except the type
  • Loading branch information
WalterMoar authored Sep 5, 2024
1 parent 14380e4 commit dbe9498
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
<!-- Provide a general summary of your changes in the Title above -->
<!--
The above Title for the Pull Request should use the format:
type: FORMS-ABCD your change description
For example:
feat: FORMS-1234 add Assigned To column to submission table
-->

# Description

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->
<!--
Describe your changes in detail.
- Why is this change required?
- What problem does it solve?
-->

## Types of changes
## Type of Change

<!-- Uncomment the main reason for the change (for example, all feat PRs should include docs and test, but only uncomment feat): -->
<!--
Uncomment the main reason for the change. For example: all "feat" PRs should
include documentation ("docs") and tests ("test"), but only uncomment "feat".
-->

<!-- feat (a new feature) -->
<!-- fix (a bug fix) -->
Expand All @@ -18,6 +29,7 @@
<!-- docs (change to documentation) -->
<!-- perf (change to improve performance) -->
<!-- refactor (change to improve code quality) -->
<!-- revert (reverts changes in a previous commit) -->
<!-- style (change to code style/formatting) -->
<!-- test (add missing tests or correct existing tests) -->

Expand All @@ -27,8 +39,10 @@ This is a breaking change because ...

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
<!--
Go over all the following points, and put an `x` in all the boxes that apply. If
you're unsure about any of these, don't hesitate to ask. We're here to help!
-->

- [ ] I have read the [CONTRIBUTING](/bcgov/common-hosted-form-service/blob/main/CONTRIBUTING.md) doc
- [ ] I have checked that unit tests pass locally with my changes
Expand All @@ -39,4 +53,8 @@ This is a breaking change because ...

## Further comments

<!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->
<!--
If this is a relatively large or complex change, kick off the discussion by
explaining why you chose the solution you did and what alternatives you
considered, etc...
-->

0 comments on commit dbe9498

Please sign in to comment.