Some README improvements
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- shell
- Domain
- documentation
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.
Description
- Add information about limitations of
rename.sharguments (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)
- Dominant language
- Makefile
- Stars
- 7
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from lsp-plugins/lsp-plugins-plugin-template
-
Add UI class and separate ui headerMay be free again @sadko4u claimed this 1002 days ago, and no pull request is open. Open
lsp-plugins/lsp-plugins-plugin-template#2 · 1 assignee ·
All issues in lsp-plugins/lsp-plugins-plugin-template
Similar issues
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 83/100
Maintainers usually reply within 3 days
-
factory-active task-identify-harness-labels-done task-identify-issue-type-done
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
vendor-pitch
Difficulty 2/5 1-3 hours Newbie friendliness 87/100
Maintainers usually reply within 1 day
-
documentation good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
eugenioenko/ttt#1000 ·
Maintainers usually reply within 1 day