Add make help #3430
Add make help #3430
Conversation
Add help target to enable make help Documented all targets and added helpful info
Makefile
Outdated
| @echo " - Standard workflow: install packages, run checks, test, and document before submitting a PR." | ||
| @echo " - Before submitting a PR, please ensure that all tests pass, code is linted, and documentation is up-to-date." |
There was a problem hiding this comment.
I think this is intended to be normative ("Your standard workflow when preparing to submit a PR should include all of installing packages, running checks, ..."), but it could also be read as a descriptive summary of what this Makefile's standard workflow does ("The effect of running the standard workflow is to install packages, run checks, ...") , raising the question of how one invokes said workflow or switches to a nonstandard one when needed.
Consider pointing to the PEcAn book for conventions on developer workflows and saying a bit more for folks in first-time installation mode who haven't yet connected that their setup process is "just" the install part of the standard dev workflow?
There was a problem hiding this comment.
see above https://github.com/PecanProject/pecan/pull/3430/files#r1942059169 and feel free to propose a specific change
There was a problem hiding this comment.
GitHub's making it hard for me to tell if you already applied the above or if it's a pending proposal, but yes it seems like an improvement.
Makefile
Outdated
| @echo " - Standard workflow: install packages, run checks, test, and document before submitting a PR." | ||
| @echo " - Before submitting a PR, please ensure that all tests pass, code is linted, and documentation is up-to-date." |
There was a problem hiding this comment.
GitHub's making it hard for me to tell if you already applied the above or if it's a pending proposal, but yes it seems like an improvement.
|
@infotroph I welcome your suggestions implemented as a PR against this branch. |
The goal is to make it easier to use PEcAn's
makefunctionality by adding documentation.This PR
TODO:
Types of changes
Checklist: