Request for description of the context (usage scenario) for commands usage
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
It would be great to add the descriptions of the commands in which case there is a need to use it. For example prestashop:licenses:update - if you develop your module (not sure that its true), prestashop:schema:update-without-foreign - if you upgrade your shop sources (not sure that its true).
Without such description, it is clear to understand what the command is doing, but it is not entirely clear why it needs to be done.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation entries for prestashop:licenses:update and prestashop:schema:update-without-foreign, then review how the commands are described today. Confirm the intended usage scenario for each command before adding guidance about when it should be used; completion means the relevant command documentation explains both what it does and why it is needed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100