Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue and PR templates #373

Open
1 of 2 tasks
petr-tik opened this issue Apr 8, 2018 · 8 comments
Open
1 of 2 tasks

Add issue and PR templates #373

petr-tik opened this issue Apr 8, 2018 · 8 comments
Assignees

Comments

@petr-tik
Copy link
Member

petr-tik commented Apr 8, 2018

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/
  • Agree and add a PR template
@ajbennieston
Copy link
Member

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

@petr-tik
Copy link
Member Author

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

@ajbennieston
Copy link
Member

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

@ajbennieston
Copy link
Member

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

@petr-tik
Copy link
Member Author

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
Copy link
Member

@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
Copy link
Collaborator

jbcoe commented May 12, 2018

Is there anything left to do here?

@petr-tik
Copy link
Member Author

Issue template still unagreed/missing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants