Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve CONTRIBUTING.md with clear installation instructions and detailed development process #56

Merged
merged 6 commits into from
Oct 11, 2024
Merged

Improve CONTRIBUTING.md with clear installation instructions and detailed development process #56

merged 6 commits into from
Oct 11, 2024

Conversation

teddyCodex
Copy link
Collaborator

@teddyCodex teddyCodex commented Oct 6, 2024 •
edited
Loading

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:

  • Added detailed steps to install and load the usethis, devtools, and lintr packages.
  • Improved the formatting of the pull request process, making it easier to understand for new contributors.
  • Updated various sections for better readability and clarity.

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality, improves documentation).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • I have added comments to my code to help provide understanding.
  • I have added a test which covers the code changes found within this PR.
  • I have deleted all non-relevant text in this pull request template.
  • Reviewer assignment: Tag a relevant team member to review and approve the changes.

@teddyCodex
Update CONTRIBUTING.md
aff97e4 
Added a couple of clearer steps to the pull request process.
@teddyCodex
Update CONTRIBUTING.md
3a0376f
@teddyCodex
Update CONTRIBUTING.md to include explicit installation steps and imp…
67a6d0e 
…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.
the-mayer
the-mayer reviewed Oct 9, 2024
View reviewed changes
.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`:
Copy link
Collaborator

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()?

the-mayer
the-mayer requested changes Oct 9, 2024
View reviewed changes
Copy link
Collaborator

@the-mayer the-mayer left a 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!

@teddyCodex
Copy link
Collaborator Author

@the-mayer file updated.

Side note:
Did not find a NEWS.md file in the repo.
Commented out the line referencing it:

For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

Suggest restoring this line when the file exists to avoid any confusion

@teddyCodex teddyCodex requested review from the-mayer and removed request for Seyi007 October 9, 2024 21:59
@teddyCodex teddyCodex changed the title Improve documentation with clear installation instructions and detailed development process Improve CONTRIBUTING.md with clear installation instructions and detailed development process Oct 9, 2024
@the-mayer the-mayer self-assigned this Oct 11, 2024
@the-mayer the-mayer added the documentation Improvements or additions to documentation, incl. R docstring/roxygen2 label Oct 11, 2024
the-mayer
the-mayer approved these changes Oct 11, 2024
View reviewed changes
Copy link
Collaborator

@the-mayer the-mayer left a 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

@the-mayer the-mayer merged commit 768eb1b into JRaviLab:main Oct 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@the-mayer the-mayer the-mayer approved these changes

Assignees

@the-mayer the-mayer

Labels
documentation Improvements or additions to documentation, incl. R docstring/roxygen2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@teddyCodex @the-mayer