lsp-plugins / lsp-plugins/lsp-plugins-plugin-template
Some README improvements
Open
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 7
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
- [ ] Add information about limitations of `rename.sh` arguments (max length, allowed symbols, etc)
- [ ] Add info how to disable 3D library dependencies if your plugin won't work with 3D (and other optional dependencies)
- [ ]
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
Review the README and rename.sh to identify the argument limits and allowed symbols that need documenting. Then inspect the existing dependency instructions to explain how to disable 3D and other optional dependencies; done means both checklist items are covered clearly in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100