Improve CONTRIBUTING.md

[Aariq]

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 R stop(), warning(), and message()
• 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.

https://github.com/PecanProject/pecan/blob/795b99877a7295d7b7e28328c786cccf4598d758/CONTRIBUTING.md?plain=1#L104

[mdietze]

💯 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

[meetagrawal09]

Updated the link in #3099

[Aariq]

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

[sambhavnoobcoder]

hey @mdietze is this still open ? I would like to solve this issue .

[allgandalf]

@sambhavnoobcoder any update on the current status of your work ?

[sambhavnoobcoder]

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 .

[allgandalf]

Can you provide a timeline of when can we expect a complete PR @sambhavnoobcoder ?