zmkfirmware / zmkfirmware/zmk-cli
Provide useful errors when repo isn't configured properly
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 20
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
If someone clones an empty repo as in #44 or the repo is otherwise missing the config/west.yml file, we should at minimum print an error message with instructions to fix it. Even better would be to offer to create the missing files.
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
Reproduce the empty-repository case described in #44 and the case where config/west.yml is missing. Trace the CLI path that handles repository configuration, then define completion as a useful error with instructions; offering to create missing files is an additional scope to clarify.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100