zmkfirmware / zmkfirmware/zmk-cli
Support nonstandard config paths
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
ZMK's build workflow allows customizing the config path and build matrix path. These values are currently hard coded in ZMK CLI. We should support changing those paths here too.
To avoid duplicate data, we could try to read from the GitHub workflow file, however that may not work if the user has replaced it with a custom workflow or is not using GitHub at all, so we may need to support something like a zmk.ini file in the root of the repo.
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 ZMK CLI code that currently hard-codes the config path and build matrix path. Review how the build workflow exposes those values and determine a configuration approach that also works without GitHub; done means both paths can be customized without duplicate or workflow-only assumptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100