ffig
ffig copied to clipboard
Add issue and PR templates
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
What do we still need to do here? The new issue / new PR buttons aren't using the templates yet...
It worked for me when comparing old branch with master - looks like the compare branch has to have the template, not the base.
You're right; recent PRs that have had the template in the branch do indeed show the template.
The issue template doesn't seem to show up, though...
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: 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!
Is there anything left to do here?
Issue template still unagreed/missing