diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 14f3a92b..e4069fe6 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,10 +6,10 @@ --- -*Please keep in mind that we try to use the issue tracker of this repository for specific bug -reports & CLI feature requests. General & troubleshooting questions are encouraged to be posted to -the [balena forums](https://forums.balena.io), which are monitored by balena's support team and -where the community can both contribute and benefit from the answers.* +*Please note that this issue tracker is used for specific bug reports and feature requests. +General and troubleshooting questions are encouraged to be posted to the [balena +forums](https://forums.balena.io), which are monitored by balena's support team and where +the community can both contribute and benefit from the answers.* *Before submitting this issue please check that this issue is not a duplicate. If there is another issue describing the same problem or feature please add your information to the existing issue's diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 122bae35..aeedc290 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,24 @@ -Resolves: # -See: -Depends-on: -Change-type: major|minor|patch +Resolves: # +Change-type: major|minor|patch +Depends-on: +See: --- -##### Contributor checklist - -- [ ] Introduces security considerations -- [ ] Affects the development, build or deployment processes of the component +Please check the CONTRIBUTING.md file for relevant information and some +guidance. Keep in mind that the CLI is a cross-platform application that runs +on Windows, macOS and Linux. Tests will be automatically run by balena CI on +all three operating systems, but this will only help if you have added test +code that exercises the modified or added feature code. + +Note that each commit's message (currently only the first line) will be +automatically copied to the CHANGELOG.md file, so try writing it in a way +that describes the feature or fix for CLI users. + +If there isn't a linked issue or if the linked issue doesn't quite match the +PR, please add a description to explain the PR's motivation and the features +that it adds. Adding comments to blocks of code that aren't self explanatory +usually helps with the review process. + +If he PR introduces security considerations or affects the development, build +or release process, please be sure to add a description and highlight this.