-
Notifications
You must be signed in to change notification settings - Fork 234
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve CONTRIBUTING.md #3095
Comments
💯 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 ? |
The contents of CONTRIBUTING is mostly generic about getting started with git and github. This should contain things like:
devtools::check()
locally on a single packagePEcAn.logger()
instead of base Rstop()
,warning()
, andmessage()
Maybe that stuff is supposed to be in this link, but it's broken.
pecan/CONTRIBUTING.md
Line 104 in 795b998
The text was updated successfully, but these errors were encountered: