Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the PR and issue templates
Motivation
PRs were failing the pr-title-checker action because the title format wasn't well documented. Rather than add this to our documentation, I think it is easier to just mention it in the PR template.
While I was doing that I also changed both templates to include instructions as comments. I think this is common in other github projects.
Changes:
Tests included
Documentation
official documentation info
I think the PR template is a better place for documentation than the other repo.