ffig icon indicating copy to clipboard operation
ffig copied to clipboard

Add issue and PR templates

Open petr-tik opened this issue 6 years ago • 8 comments

According to GitHub documentation, issues and PRs can automatically use templates from .github/ or docs/ directories.

Currently, docs/ has a subdir ISSUE_TEMPLATE with 2 files. Unfortunately, this isn't recognised and offered by GitHub UI.

  • [ ] Agree on generic issue template - combine bug report and feature request or default to bug report/
  • [x] Agree and add a PR template

petr-tik avatar Apr 08 '18 21:04 petr-tik

What do we still need to do here? The new issue / new PR buttons aren't using the templates yet...

ajbennieston avatar Apr 12 '18 08:04 ajbennieston

It worked for me when comparing old branch with master - looks like the compare branch has to have the template, not the base.

petr-tik avatar Apr 12 '18 09:04 petr-tik

You're right; recent PRs that have had the template in the branch do indeed show the template.

ajbennieston avatar Apr 13 '18 11:04 ajbennieston

The issue template doesn't seem to show up, though...

ajbennieston avatar Apr 13 '18 11:04 ajbennieston

The issue template needs to be in the root of docs/ folder.

I suggest we decide on a generic issue format that can be used for bugs and feature requests.

We can keep separate templates for bugs and feature requests, if we intend to add a button on the website/Readme.

GitHub recently added support for choosing issue/PR template with url parameters

petr-tik avatar Apr 13 '18 13:04 petr-tik

@petr-tik: A single template sounds good to me, for now.

I had originally thought we could have multiple templates and links from the README that use the URL parameters to select the correct template for filing a bug or requesting a feature... but a lot of people will probably go directly via the New Issue button, so it makes sense to have a single template that is always active!

ajbennieston avatar Apr 13 '18 13:04 ajbennieston

Is there anything left to do here?

jbcoe avatar May 12 '18 12:05 jbcoe

Issue template still unagreed/missing

petr-tik avatar May 20 '18 21:05 petr-tik