search

singularity-energy / open-grid-emissions

Tools for producing high-quality hourly generation and emissions data for U.S. electric grids
MIT License
67 stars 4 forks source link

Add pull request template #312

Closed rouille closed 7 months ago

rouille commented 7 months ago

Add pull request template. Closes #311.

Users opening a PR will have the following template:

Screenshot 2023-11-22 at 3 22 02 PM
rouille commented 7 months ago

Thanks, Ben! I'd like to suggest a couple of additional additions to the PR template:

* I think that it helpful to add a section for something like "Future work" that describes if work in this PR unearthed any issues that are not being fixed in this PR but should be addressed in the future

* I think it would also be helpful to have a "PR Checklist" section that includes things that the requestor should always check before marking the PR ready for review, such as:

  * [ ]  Update the documentation to reflect changes made in this PR
  * [ ]  Format all updated python files using `black`
  * [ ]  Clear outputs from all notebooks modified
  * [ ]  Docstring and type hints added to any new functions created
  * [ ]  (Anything else you think is a good practice for people to check before submitting)

I have updated the template. @grgmiller, let me know what you think?