Clarified contributer guidelines #856
Description
The contributor guidelines are missing a few critical details about how to submit contributions. These updates are required to help guide others to be able to effeciently open pull requests with their contributions and reduce the number of requested changes in pull requests.
- Pull request title/body format. Title and body format adhere to conventional commit conventions used by repo; example below.
Sample pull request format and breakdown:
docs: improved contributor guidelines
Includes information around the use of conventional commits in commit messages and pull request title/body.
Fixes #ISSUE_NUMBER_1
Fixes #ISSUE_NUMBER_2 (if applicable)
BREAKING CHANGE this introduces a backward incompatiable change. Here is what users need to do in order to upgrade. (This is only applicable for breaking changes; omitted otherwise).
The first line is the PR title. It starts with the type followed by a colon and then a short summary of the PR. The body includes a brief description of the what changed. This should also include any important call outs in terms of technical decisions and/or implications. In doing so, it provides an easier way to distill code changes into meaningful reasons. This is followed by phrasing to indicate to GitHub what issue(s) are associated and resolved by the pull request. Finally, if and only if the PR contains a backwards incompatable change, the BREAKING CHANGE pharse is used, followed by a summary of how users must act in order to upgrade.