Add Issue Templates

[djbrooke]

Github offers issue templates. We should investigate these, and if we think they'd be useful, we should make use of them and update the documentation to explain their purpose.

https://help.github.com/articles/about-issue-and-pull-request-templates

[djbrooke]

@ysuarez, @pdurbin mentioned you may be interested in this. If so, let me know and I'll assign it to you and we can work on it together. If you're not interested or if you don't have time to work on this right now, let me know and I'll work on it in the sprint starting 10/9.

[ysuarez]

@djbrooke yes, I would like to work on this with you. I will write out some of my specific ideas inspired by what I saw in the PR templates of a couple of other open source projects.

BTW, from my extremely brief notes from the 2019 Dataverse community meeting on this, I see that I was thinking of somehow creating a "fork in the road" for submitting issues. By this I mean somehow using these Github templates to better guide non-tech savvy issue submitters to provide enough details for submitting a bug, versus submitting a new feature request. Though I don't want the project to end up with a long and/or complicated issue template, and my idea may be impossible to achieve in the end.

[ysuarez]

@djbrooke nevermind, my memory failed me. This is the "fork in the road" I was originally thinking about...

from: https://help.github.com/en/articles/about-issue-and-pull-request-templates

I assume within those two options for a new issue we can create a Markdown based template with suggested fields for the users to fill out for the respective type of issue.

[pdurbin]

@ysuarez thanks for jumping in!

It seems like this article describes an "issue template builder" or wizard for setting this up: https://help.github.com/en/articles/creating-issue-templates-for-your-repository

As a readonly user of this repo, I'm not sure if you have access to that wizard or not.

The GitHub docs don't seem to explain how to set up the new style issue templates manually but I think https://github.com/publiclab/plots2/issues is a good example of how fancy you can get. Here's a screenshot:

We can take a look at the YAML they used at publiclab/plots2#5967

[ysuarez]

@djbrooke sorry for the radio silence, I had a hackathon competition last week and got slammed. I am currently attending the Islandora conference, and we were talking about issues. This gave me a chance to create my own private repo to try out creating Github Issue templates. Would you like me to add you to this private repo (I can make it public too) so we can work together on this?

Let me know.

[djbrooke]

Sure thing @ysuarez, public is fine with me unless there's some reason not to open it up.

[ysuarez]

@djbrooke I made it public and added you as a collaborator.

https://github.com/ysuarez/github_issue_templates_experiments

[pdurbin]

@ysuarez your templates look good to me! 😄

[ysuarez]

@pdurbin for the record, those are the Github default templates and their content. It was not customized by me at all.

Here are some screenshots of the defaults....

[pdurbin]

Cool. The defaults seem like a good starting point. We can always iterate on them in the future.

We aim for "small chunks" in our development process. And we use the phrase "incremental progress" a lot. The idea is that every pull request, no matter how small, helps move us forward.

Oh! That reminds me! It's Hactoberfest! I'm totally adding that label to this issue. See also https://groups.google.com/d/msg/dataverse-community/ootwCQL-4K4/00QO3__8CQAJ

[ysuarez]

@djbrooke Did you want to coordinate by email/slack/phone to deploy these templates? I do not have access to Dataverse repo to do it, but we can try out content variations on my test repo. Let me know.

[djbrooke]

Hey @ysuarez thanks for checking in. I'm excited to see what you've been working on. Let's use your test repo to discuss and edit and then we can just bring in the .md files to the Dataverse repo.

If you want to point me at what you have, we can set up a video call next week sometime. Would either 1 PM on Wednesday or 3 PM on Thursday work for you?