JRaviLab / MolEvolvR

An R Package for characterizing proteins using molecular evolution and phylogeny
https://jravilab.github.io/MolEvolvR/
Other
6 stars 16 forks source link

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

Closed teddyCodex closed 1 month ago

teddyCodex commented 1 month ago

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:

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.

teddyCodex commented 1 month ago

@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