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 #130

Closed
yardasol opened this issue Oct 16, 2020 · 3 comments · Fixed by #178
Closed

Create templates for issues and pull requests #130

yardasol opened this issue Oct 16, 2020 · 3 comments · Fixed by #178

Comments

@yardasol
Copy link
Contributor

yardasol commented Oct 16, 2020

EDIT 1: The first comment below strongly discourages an entire new document be created for contributing and suggests using GitHub templates instead along with editing he CONTRIBUTING.md document. I agree this is a much more efficient approach. The issue has been updated to reflect this.

Moltres development could be improved by adding templates for issues and pull requests. The existence of these templates can be noted in the CONTRIBUTING.md document.

This issue can be closed when templates for issues and pull requests exist, and the existence of these templates is specified in the CONTRIBUTING.md document.

Original issue preserved below

Original Title: Create a Contributing Guide

Moltres does not have a Contributing Guide. A Contributing Guide defines the appropriate procedure for making contributions to a project. A contributing guide is important for open source projects like Moltres to ensure that code issues are dealt with appropriately and efficiently.

The Contributing Guide should specify

  • steps for submitting a bug report/feature request/other misc. project thingy and the expected structure of such a report/request/thingy
  • steps for reviewing a bug report/feature request/other misc. project thingy and the expected structure of such a review of said report/request/thingy

Many of these items already exist in the current CONTRIBUTING.md document.

This list is not comprehensive and should be updated as necessary. The Contributing Guide should use clear, concise, and easy to read language. A good place to start for inspiration might be the ARFC Guides or the OpenMC contributing guide

This issue can be closed once a Contributing guide that addresses the above items exists.

@katyhuff
Copy link
Member

katyhuff commented Oct 16, 2020

  • Moltres has a contributors guide. It's CONTRIBUTING.md, which you've noted. A new "contributing guide" should not be created. If things are missing from contributing.md, then perhaps they should be added to contributing.md. A new document should not be created because it will create a second place to maintain in parallel.
  • There is no need in any git workflow for folks to "review a bug report/feature request/other misc. project thingy". There is already a whole section in CONTRIBUTING.md on reviewing pull requests. https://github.com/arfc/moltres/blob/devel/CONTRIBUTING.md#reviewing-a-pull-request

If you'd like to add a section to contributing.md about how to create an issue, then that would be a fine thing. If you'd like to add an issue_template or pull_request_template, then that would be fine too.

I strongly discourage a second document.

@yardasol yardasol changed the title Create a Contributing Guide Create templates for issues and pull requests Oct 16, 2020
@yardasol
Copy link
Contributor Author

I see your point and I agree. The issue has been updated.

@katyhuff
Copy link
Member

Thanks!!

Moltres automation moved this from new to completed Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: completed
Moltres
  
completed
Development

Successfully merging a pull request may close this issue.

2 participants