For PR template, minor fix to 'please read'
section, as symbol spacing was different
on GitHub website than on GitHub Desktop.
Added HTML comment with example on how
to complete the checklist using [x]. Added
examples to the 'tested on' section.
Added abbreviation explanation for PR to
better understand terminology, similar to
using S.O.B. For CONTRIBUTING.md,
bumped up release branch example, and
minor capitalisation fixes for PR.
Signed-off-by: Joshua Criss <owlsy@outlook.com.au>
As a new person to contributing on GitHub,
I noticed the CONTRIBUTING.md missing
some important information that I would not
have known until I tried my first pull request,
such as the character limits and email
requirements. I've seen others also get
tripped up by this too, as they also were not
aware until afterwards. So, I have tried to
include the common ones into the
Contributing Guidelines, along with some
minor capitalisation updates for consistency.
Will also update the Pull Request template
to achieve the same goal as well.
Signed-off-by: Joshua Criss <owlsy@outlook.com.au>
Add advice on pull requests and best practices in working with Github.
Minor corrections & updates.
Adjust to Github 'markdown' syntax.
Signed-off-by: Hannu Nyman <hannu.nyman@iki.fi>
Joshua Criss