search

FFIG / ffig

Generate code to call C++ libraries from other languages
MIT License
29 stars 9 forks source link

Add issue and PR templates #373

Open petr-tik opened 6 years ago

petr-tik commented 6 years ago

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.

ajbennieston commented 6 years ago

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

petr-tik commented 6 years ago

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

ajbennieston commented 6 years ago

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

ajbennieston commented 6 years ago

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

petr-tik commented 6 years ago

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

ajbennieston commented 6 years ago

@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!

jbcoe commented 6 years ago

Is there anything left to do here?

petr-tik commented 6 years ago

Issue template still unagreed/missing