matryer / matryer/xbar-plugins
Setup instructions for plugins
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 2.6k
- Forks
- 1.1k
- Avg merge
- 9d 15h
- Merged PRs (30d)
- 1
Description
Some plug-in may need special setup like python module install, special setup on a web service, etc..
The description metadata might not be enough for complexe case and anyway a description should be a description, not a manual
My idea would be to add a .md file names like the module when needed. This xbar GUI would then display this when it exists
Contributor guide
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
No files or tests are named. Review how plugin description metadata is stored and how the xbar GUI currently presents it, then check existing plugin naming conventions for an optional module-named .md file. Done means special setup instructions can be authored separately and are displayed by the GUI when that file exists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100