Open csala opened 5 years ago
Any thoughts on this @micahjsmith ?
I really think that resorting the targets as suggested would make it much easier for the user to both see what options there are when executing make help
and to find and understand related things when reading the Makefile contents directly.
Current Makefile has the targets ordered in a way that is difficult to read and understand.
I suggest resorting them following these two guidelines:
group all the targets by concepts
Put all the targets related to clean, install, lint, test, docs and release grouped by what they relate to.
This makes much easier to understand which variations of each command exist.
For example, current help command shows:
Here, commands like
install-develp
orcoverage
might be skipped, as they are separated from what they relate to.So, instead of that, I'd rather order them like this, which shows them all grouped:
So all the install, test, lint and docs commands are grouped together.
Things that are used by others go first
This is not that important, but I'd always sort the groups so that individual commands show before the composed ones.
For example, instead of starting the clean group with the composed
clean
command, I would put it at the end, so it's clearer that this is just a call to all the others: