arfc / moltres

Repository for Moltres, a code for simulating Molten Salt Reactors
GNU Lesser General Public License v2.1
66 stars 41 forks source link

PR and Issue templates #178

Closed yardasol closed 1 month ago

yardasol commented 2 years ago

This PR adds PR and Issue templates to the repo. They are similar to the ones i made for SaltProc but with some better formatting.

closes #130

yardasol commented 4 months ago

@katyhuff @smpark7 bump

smpark7 commented 4 months ago

(Meta question) Do we want the templates to be strictly followed or to be general guidelines? I recognize the benefits of standardization since we welcome outside contributors, but I find the headers in the issue templates to be quite restrictive. I would prefer to have the Expected behavior, Describe the bug, and To reproduce headers be guidelines instead under one big section named Description.

As for the PR template, I think the checklist is good for reminding contributors (and ourselves) of our expectations.

yardasol commented 4 months ago

@smpark7 great suggestions. Could you go ahead and suggest those changes so you can get commit credit for them?

katyhuff commented 1 month ago

@yardasol @smpark7 Can you take a quick look at my final comment and decide what to do with this PR?

smpark7 commented 1 month ago

I'm okay with merging as is and refining the template later.

katyhuff commented 1 month ago

Thank you. Merged.