search

NRL-Plasma-Physics-Division / turbopy

A lightweight computational physics framework, based on the organization of turboWAVE. Implements a "Simulation, PhysicsModule, ComputeTool, Diagnostic" class hierarchy.
https://turbopy.readthedocs.io/
Creative Commons Zero v1.0 Universal
10 stars 18 forks source link

Create templates for Issues and Pull Requests #41

Open littlewatkins opened 4 years ago

littlewatkins commented 4 years ago

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

GarethTMorgan commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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

GarethTMorgan commented 4 years ago

Thanks Grace! I'll check that out.

GarethTMorgan commented 4 years ago

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

gracetangg commented 4 years ago

@GarethTMorgan sorry i'm not sure about that

GarethTMorgan commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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