Templates help contributors ticket more straightforward issues and pull requests. We should add them to all our code repositories.

How

Here's some GitHub documentation about it:

https://docs.github.com/en/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository

I added some rough examples to the testing repository, see all the TEMPLATEs:

https://github.com/ignitionrobotics/testing/tree/main/.github

The two options show up when ticketing an issue:

https://github.com/ignitionrobotics/testing/issues/new/choose

Opening a PR uses the default pull request template (the one outside the folder):

gazebosim/testing@main...another_branch

And the other PR templates can be accessed using the ?template= query (unfortunately, not through the UI yet):

• https://github.com/ignitionrobotics/testing/compare/main...another_branch?template=bug_fix.md
• https://github.com/ignitionrobotics/testing/compare/main...another_branch?template=new_feature.md
• https://github.com/ignitionrobotics/testing/compare/main...another_branch?template=port.md

Unfortunately, it looks like the automated title and labels aren't working for PR templates 😕

Content

We should have 2 issue templates: bugs and features, and 3 PR templates: bugs, features and ports.

There are lots of nice guides online for what to include in these templates. I'll brainstorm some ideas below and mention some Ignition-specific things.

Issues

Bug

• User environment (versions, installation method, OS...)
• Reproduction steps
• Screenshots, logs, backtraces...
• ...

Feature

• Desired behaviour
• Implementation suggestion
• Alternatives considered

PRs

Bug

• Issue that is fixed
• How to reproduce bug before and after
• DCO
• Added tests?
• Message to squash-merge

Feature

• Issue that is addressed
• How to try out the feature manually
• DCO
• Added tests?
• Added example world? Tutorial?
• Message to squash-merge

Ports

• From branch
• To branch
• Comparison link
• Message to merge with commit (no squash or rebase)