Skip to content

Commit

Permalink
Update for PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jdangerx committed Dec 5, 2023
1 parent 8938025 commit 4b94ff5
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ How did you make sure this worked? How can a reviewer verify this?
# To-do list
- [ ] Make sure full ETL runs & `make pytest-integration-full` passes locally
- [ ] For major data coverage & analysis changes, [run data validation tests](https://catalystcoop-pudl.readthedocs.io/en/latest/dev/testing.html#data-validation)
- [ ] If updating analyses or data processing functions: write data quality checks
- [ ] If updating analyses or data processing functions: make sure to update or write data validation tests
- [ ] Update the [release notes](../docs/release_notes.rst): reference the PR and related issues.
- [ ] Review the PR yourself and call out any questions or issues you have
```
25 changes: 14 additions & 11 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
--------------------
Contributing to PUDL
--------------------
-------------------------
Contributing Code to PUDL
-------------------------

Welcome! We're so glad you're interested in contributing to PUDL! We would love
some help making PUDL data as complete as possible.
Expand All @@ -9,8 +9,8 @@ some help making PUDL data as complete as possible.

.. IMPORTANT:: Already have a dataset in mind?

If you **need data that's not in PUDL** that we're missing in PUDL,
`open an issue <https://github.com/catalyst-cooperative/pudl/issues/new?assignees=&labels=new-data&projects=&template=new_dataset.md&title=>`__
If you **need data that's not in PUDL**, `open an issue
<https://github.com/catalyst-cooperative/pudl/issues/new?assignees=&labels=new-data&projects=&template=new_dataset.md&title=>`__
to tell us more about it!

If you've **already written some code to wrangle a dataset**, find us at
Expand All @@ -35,16 +35,19 @@ You'll need to fork this repository and get the
are issues that don't require a ton of PUDL-specific context, and are
relatively tightly scoped.

* Comment on the issue and tag ``@com-dev`` (our Community Development Team) to
let us know you're working on it. Feel free to ask any questions you might
have!
* Comment on the issue and tag ``@catalyst-cooperative/com-dev`` (our Community
Development Team) to let us know you're working on it. Feel free to ask any
questions you might have!

* Once you have an idea of how you want to tackle this issue, write out your
plan so we can guide you around obstacles in your way! Post a comment outlining:
* what steps have you broken this down into?
* what is the output of each step?
* how will one know that each step is working?

* Once you've talked through your plan with someone from Catalyst, go forth and
develop!

**Work on it!**

* Make a branch on your fork and open a draft pull request (PR) early so we can
Expand All @@ -64,9 +67,9 @@ You'll need to fork this repository and get the

**Get it merged in!**

* Turn the draft PR into a normal PR and ping ``@com-dev``. We'll try to get
back to you within a few days - the smaller/simpler the PR, the faster we'll
be able to get back to you.
* Turn the draft PR into a normal PR and tag ``@catalyst-cooperative/com-dev``
in a comment. We'll try to get back to you within a few days - the
smaller/simpler the PR, the faster we'll be able to get back to you.

* The reviewer will leave comments - if they request changes, address their
concerns and re-request review.
Expand Down
4 changes: 4 additions & 0 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Data Liberation effort!
We need lots of help with :ref:`user-feedback`, we welcome :ref:`code-contribs`, and
it would be great to :ref:`connect-orgs` that we can work with.

Finally, `financial donations
<https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PZBZDFNKBJW5E&source=url>`__
are welcome too!

---------------
Code of Conduct
---------------
Expand Down

0 comments on commit 4b94ff5

Please sign in to comment.