it-at-m / it-at-m/itm-java-codeformat
Add documentation in english
Open
documentation
good first issue
- Dominant language
- Java
- Stars
- 1
- Forks
- 2
- Avg merge
- 13h 12m
- Merged PRs (30d)
- 1
Description
As some (or many) it@M projects use english as developer language, the README also should contain a section with usage instruction in english.
Example project:
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by opening the repository README and reviewing its current language and usage sections. Add an English usage-instructions section for the formatter; the work is done when developers can find those instructions in the README and the existing content remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100