Move Xbar plugin guide to xbar-plugins
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 18.1k
- Forks
- 656
- PR merge metrics
- No merged PRs in 30d
Description
It does not really make much sense to have the plugin building guide in the README of `Xbar` repo, especially when https://github.com/matryer/xbar-plugins#add-your-own-plugin backlinks to this repo. A solution would be to create a standard `CONTRIBUTING.md` in the `Xbar-plugins` repo and move the plugin writing guide there.
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 comparing the plugin writing guide in the Xbar README with the xbar-plugins repository's existing “Add your own plugin” guidance. Move the guide into a standard CONTRIBUTING.md in xbar-plugins and preserve or add the backlink between the repositories; done means contributors can find the complete guide there.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100