Address PR feedback

.github/ISSUE_TEMPLATE/new_dataset.md

@@ -2,18 +2,27 @@
 name: New dataset
 about: Provide information about a new dataset you'd like to see in PUDL
 title: ''
-labels: new-dataset
+labels: new-data
 assignees: ''
 ---
 
 ### Overview
 
-What is this dataset? Why do you want it in PUDL? Is it already partially in
-PUDL, or do we need to start from scratch?
+What is this dataset?
 
-### Where is it?
+Why do you want it in PUDL?
 
-Is this dataset publically available? Where can one download the actual data?
+Is it already partially in PUDL, or do we need to start from scratch?
+
+### Logistics
+
+Is this dataset publically available?
+
+Where can one download the actual data?
+
+How often does this dataset get updated?
+
+What licensing restrictions apply?
 
 ### What do you know about it so far?
 

.github/pull_request_template.md

@@ -16,7 +16,7 @@ What did you change?
 How did you make sure this worked? How can a reviewer verify this?
 
 ```[tasklist]
-# Remaining work
+# 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

.github/workflows/build-deploy-pudl.yml

@@ -131,4 +131,5 @@ jobs:
           channel-id: "C03FHB9N0PQ"
           slack-message: "build-deploy-pudl status: ${{ job.status }}\n${{ env.ACTION_SHA }}-${{ env.GITHUB_REF }}"
         env:
+          channel-id: "C03FHB9N0PQ"
           SLACK_BOT_TOKEN: ${{ secrets.PUDL_DEPLOY_SLACK_TOKEN }}

CONTRIBUTING.rst

@@ -10,15 +10,12 @@ 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/choose>`__.
+   `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
    `office hours <https://calend.ly/catalyst-cooperative/pudl-office-hours>`__ and we
-   can talk through next steps for how to get that into PUDL.
-
-   ..
-     If you **want to use PUDL tools to explore a dataset we don't have yet**,
-     try using our example Kaggle notebook!
+   can talk through next steps.
 
 
 Your first contribution
@@ -33,34 +30,55 @@ You'll need to fork this repository and get the
 
 * Look for issues with the `good first issue
   <https://github.com/catalyst-cooperative/pudl/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue>`__
-  tag. These are issues that don't require a ton of PUDL-specific context, and
-  are relatively tightly scoped to boot.
+  tag in our `Community Kanban Board
+  <https://github.com/orgs/catalyst-cooperative/projects/9/views/19>`__. These
+  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!
 
 * 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.
+  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?
 
 **Work on it!**
 
-* Make a branch on your fork and open a draft PR early so we can discuss
-  concrete code! Please don't wait until it's all polished up - it's much easier
-  for us to help you when we can see the code evolve over time.
+* Make a branch on your fork and open a draft pull request (PR) early so we can
+  discuss concrete code! **Set the base branch to ``dev`` unless there's a good
+  reason otherwise.** Please don't wait until it's all polished up - it's much
+  easier for us to help you when we can see the code evolve over time.
 
 * Please make sure to write tests and documentation for your code - if you run
   into trouble with writing tests, let us know in the comments and we can help!
+  We automatically run the test suite for all PRs, but some of those will have
+  to be manually approved by Catalyst members for safety reasons.
 
-* Please try to keep your changes relatively small: stuff happens, and one's
+* **Try to keep your changes relatively small:** stuff happens, and one's
   bandwidth for volunteer work can fluctuate frequently. If you make a bunch of
   small changes, it's much easier to pause on a project without losing a ton of
-  context.
+  context. We try to keep PRs to **less than 500 lines of code.**
 
 **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.
+  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.
+
+* There will probably be some back-and-forth until your PR is approved - this
+  is normal and a sign of good communication on your part! Don't be shy about
+  asking us for updates and re-requesting review!
+
+* Don't accidentally "start a review" when responding to comments! If this does
+  happen, don't forget to submit the review you've started so the other PR
+  participants can see your comments (they are invisible to others if marked
+  "Pending").
 
 Next contributions
 ------------------

docs/CONTRIBUTING.rst

@@ -6,11 +6,8 @@ Contributing to PUDL
 Welcome! We're excited that you're interested in contributing to the Public Utility
 Data Liberation effort!
 
-If you're interested in contributing directly to the PUDL database, see
-:ref:`direct-contribs`.
-
-It can also be very helpful to provide :ref:`user-feedback`, or
-help :ref:`connect-orgs` that we can work with.
+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.
 
 ---------------
 Code of Conduct
@@ -21,36 +18,40 @@ based on the `Contributor Covenant <https://www.contributor-covenant.org/>`__. W
 want to make the PUDL project welcoming to contributors with different levels of
 experience and diverse personal backgrounds.
 
-.. _direct-contribs:
-
---------------------
-Direct contributions
---------------------
-
-.. include:: ../CONTRIBUTING.rst
-   :start-after: after-intro:
-
 .. _user-feedback:
 
 -------------
 User feedback
 -------------
 
 PUDL's goal is to help people use data to make change in the US energy landscape.
+As such, it's critical that we understand our users' needs! `GitHub Discussions
+<https://github.com/orgs/catalyst-cooperative/discussions>`__ is our main forum
+for all this. Since it's publicly readable, any conversation here can
+potentially benefit other users too!
+
+We'd love it if you could:
+
+* Tell us what problems you're running into, in the `Help Me!
+  <https://github.com/orgs/catalyst-cooperative/discussions/categories/help-me>`__
+  discussion board
+* Tell us about what data you're looking for by opening an `issue
+  <https://github.com/catalyst-cooperative/pudl/issues/new?assignees=&labels=new-data&projects=&template=new_dataset.md&title=>`__
+* Tell us what you're trying to do with PUDL data in `this thread
+  <https://github.com/orgs/catalyst-cooperative/discussions/3105>`__
+* `File bug reports <https://github.com/catalyst-cooperative/pudl/issues/new?template=bug_report.md>`__ on Github.
+* Tell us what you'd like to see in PUDL in the `Ideas
+  <https://github.com/orgs/catalyst-cooperative/discussions/categories/ideas>`__
+  discussion board
+
+.. _code-contribs:
 
-As such, it's critical that we understand our users' needs!
-
-We'd love to hear about:
-
-* what data you're looking for that we don't have
-* what you're trying to do with PUDL data
-* what issues you're running into with data access or interpretation
-* any problems you find in our data
-* anything you find confusing in our documentation
+--------------------
+Code contributions
+--------------------
 
-`GitHub Discussions <https://github.com/orgs/catalyst-cooperative/discussions>`__
-is a great place to do this, but `emailing us <mailto:[email protected]>`__
-works too!
+.. include:: ../CONTRIBUTING.rst
+   :start-after: after-intro:
 
 .. _connect-orgs: