satisfactorymodding / satisfactorymodding/SatisfactoryModLoader
Improve consistency of chat command user-facing data
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 344
- Forks
- 225
- PR merge metrics
- No merged PRs in 30d
Description
- Chat command helptext is currently exactly what the developer writes
- Standards for optional vs required arguments (possible to enforce?) ex.
[optional] <required> (required) - Fallback for if no helptext is written
- Communicate aliases somehow
Developer experience:
- Fix #397
- Hidden commands? (For deprecating an old command name)
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 reviewing the chat command helptext, argument, alias, and hidden-command entry points, then read linked issue #397 and the referenced Discord discussion. Done means the requested user-facing data and developer-experience behavior have agreed, consistent requirements and corresponding validation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100