Improve CONTRIBUTING.md
Aariq opened this issue · comments
The contents of CONTRIBUTING is mostly generic about getting started with git and github. This should contain things like:
- How to write tests for functions that need BETY
- How to run
devtools::check()locally on a single package - That you should use
PEcAn.logger()instead of base Rstop(),warning(), andmessage() - Who to tag in PR reviews
- What scripts need to be re-run and when (e.g. https://github.com/PecanProject/pecan/blob/develop/scripts/generate_dependencies.R)
Maybe that stuff is supposed to be in this link, but it's broken.
Line 104 in 795b998
💯 agree this all needs to be documented and made much more clear, both for onboarding and as a checklist / standard operating procedure for the rest of us. FYI I think that broken link could probably be updated to https://pecanproject.github.io/pecan-documentation/master/developer-guide.html
Updated the link in #3099
A tool that helps you figure out if your CONTRIBUTING.md is good: https://contributing.streamlit.app/
More here: https://fron.ch/preprint_fse.pdf
hey @mdietze is this still open ? I would like to solve this issue .
@sambhavnoobcoder any update on the current status of your work ?
had a draft pr up and ready , but haven't completed it yet due to other tasks , I'll upload the draft pr if required , else if I am able to get the work done quickly , I'll upload the entire pr only .
Can you provide a timeline of when can we expect a complete PR @sambhavnoobcoder ?