chore: Add script descriptions to composer file #2951
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
We are getting more and more commands in our composer file. For first time collaborators its must sometimes be hard to find out what all these commands are meant for.
Solution
Use scripts-description
Impact
Better understanding of what tests do.
Usage Changes
No
Considerations
commands are being grouped when running
composer list. But the commandcsfor example is not being shown here because its more at the top of the list.We could even better group commands by prefixing them all. But maybe just adding a description in the composer file for all to read is a perfect start.