-
Notifications
You must be signed in to change notification settings - Fork 15
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 with clear installation instructions and detailed development process #56
Conversation
Added a couple of clearer steps to the pull request process.
…roved clarity for development process - Added explicit instructions for installing and loading the `usethis`, `devtools`, and `lintr` packages. - Overall improvements to make the documentation more user-friendly, especially for new contributors.
.github/CONTRIBUTING.md
Outdated
``` | ||
usethis::create_from_github("JRaviLab/MolEvolvR", fork = TRUE) | ||
``` | ||
* Install all development dependencies and then make sure the package passes R CMD check using `devtools`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this package includes Bioconductor dependencies, we should probably include instructions on installing BiocManager as well. Perhaps after this section, but before devtools::install_dev_deps()
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for expanding the contribution guidelines. Since we are making changes, I think now might be a good time to add some additional information on getting BiocManager installed as well -- I don't think devtools::install_dev_deps()
will manage this on it's own.
@teddyCodex , if you could confirm and modify as appropriate, it would be appreciated!
@the-mayer file updated. Side note:
Suggest restoring this line when the file exists to avoid any confusion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good changes @teddyCodex , sending to main
Description
This PR updates the CONTRIBUTING.md documentation to provide clearer instructions for setting up a development environment and contributing to the project. Key changes include:
usethis
,devtools
, andlintr
packages.What kind of change(s) are included?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.