Reorganize contributing docs + add process description. #3044
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #3044 +/- ##
=======================================
- Coverage 92.6% 92.6% -0.0%
=======================================
Files 134 134
Lines 12535 12535
=======================================
- Hits 11607 11606 -1
- Misses 928 929 +1 ☔ View full report in Codecov by Sentry. |
jdangerx
force-pushed
the
contributing-docs-streamline
branch
2 times, most recently
from
782a054 to
a431dac
Compare
There was a problem hiding this comment.
🤷 seemed like maybe something useful to have? But also we can scrap it for now and new dataset requests can come in through "Feature Request."
There was a problem hiding this comment.
I think it's fine to keep this for now! Simple enough. Might change later.
.github/pull_request_template.md
Outdated
| - [ ] All CI checks are passing. [Run tests locally to debug failures](https://catalystcoop-pudl.readthedocs.io/en/latest/dev/testing.html#running-tests-with-tox) | ||
| - [ ] Make sure you've included good docstrings. | ||
| ```[tasklist] | ||
| # Remaining work |
There was a problem hiding this comment.
A lot of times people open PRs and then have some sort of TODO list to keep track of "what else needs to change before this is ready for prime time." Seems like the PR checklist should just combine with that, but I'm not quite sure how to communicate that clearly.
Separately, I deleted a bunch of stuff that should get captured by the GH UI (keeping your branch up to date with base branch), CI checks, etc. Left local integration tests in place because that actually costs $ to run on CI willy-nilly.
jdangerx
force-pushed
the
contributing-docs-streamline
branch
2 times, most recently
from
6890759 to
1cd95aa
Compare
There was a problem hiding this comment.
I think it's fine to keep this for now! Simple enough. Might change later.
.github/pull_request_template.md
Outdated
| - [ ] Defensive data quality/sanity checks in analyses & data processing functions. | ||
| - [ ] Update the [release notes](https://catalystcoop-pudl.readthedocs.io/en/latest/release_notes.html) and reference reference the PR and related issues. | ||
| - [ ] Do your own explanatory review of the PR to help the reviewer understand what's going on and identify issues preemptively. | ||
| - [ ] If updating analyses or data processing functions: write data quality checks |
There was a problem hiding this comment.
By data quality checks do you mean adding data validation tests or writing more defensive code? It might be nice to have a link to more detail here. I don't think we currently have any docs explaining data quality standards or examples of checks though.
CONTRIBUTING.rst
Outdated
|
|
||
| .. IMPORTANT:: Already have a dataset in mind? | ||
|
|
||
| If you **need data that's not in PUDL** that we're missing in PUDL, |
There was a problem hiding this comment.
"Data that's not in PUDL that we're missing in PUDL sounds redundant.
| Connect us with other organizations | ||
| ----------------------------------- | ||
|
|
||
| For PUDL to make a bigger impact, we need to find more people who need the data. |
There was a problem hiding this comment.
Maybe we should include our email somewhere here?
jdangerx
force-pushed
the
contributing-docs-streamline
branch
from
a7bc6e4 to
3d2c405
Compare
Reorganize & streamline contributing docs - hopefully makes it easier for someone who wants to help out to figure out what specifically they can do.