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

Create templates for Issues and Pull Requests #41

Open
littlewatkins opened this issue Jul 21, 2020 · 11 comments
Open

Create templates for Issues and Pull Requests #41

littlewatkins opened this issue Jul 21, 2020 · 11 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@littlewatkins
Copy link

We need to add some templates for the issues so that we can make issue creation easier.

@littlewatkins littlewatkins added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jul 21, 2020
@GarethTMorgan
Copy link

insert facepalm here I cannot implement templates because I do not have access to this repo's setting haha. @littlewatkins are you an admin/someone who can access repo settings?

@arichar6
Copy link
Collaborator

I think that only Paul and I are admins. Is there some way you can put a template into an md file or something, so that I can grab them from there and add them to the project?

@gracetangg
Copy link

@GarethTMorgan you should be able to create a .github folder and then put in the templates you want inside a ISSUE_TEMPLATE folder

@GarethTMorgan
Copy link

Thanks Grace! I'll check that out.

@GarethTMorgan
Copy link

@gracetangg do you know if making the .github folder a hidden folder will mess with anything?

@gracetangg
Copy link

@GarethTMorgan sorry i'm not sure about that

@GarethTMorgan
Copy link

all good, I'll do some googling 👍 also, can I have you check my work on PR #44 ? I figure that since you've done it before you would be good at catching if/where I need to make edits haha.

@arichar6
Copy link
Collaborator

I merged your PR #44. Now we need to think some more about what templates we should have, and how to make them more useful.

Maybe we can use some of the ideas here? Or get inspiration from some of these examples?

@arichar6
Copy link
Collaborator

Have any of you seen this templates site? It's in a choose-your-own-adventure style (which is fun 🎉 ), and some of the templates actually look pretty good.

Maybe we can get some ideas there?

@GarethTMorgan
Copy link

GarethTMorgan commented Jul 21, 2020

So the issue templates I pushed earlier seem to be working correctly which is great (thanks @gracetangg for the assistance 👍). Right now the current list of issue templates that I have in my head that have not already been put in is: documentation, discussion, questions, and feature requests (although "feature" could have a broader meaning that would encompass things like for issues 13, 9, and 8 which I am tactfully not pinging so as to cut down on unrelated clutter). Would love some feedback.

@padamson
Copy link

I think we need to consider some new items for the PR template:

  • provide documentation
  • provide unit tests
  • consider providing integration tests for new features
  • ensure existing and new tests pass

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants