checkstyle / checkstyle/checkstyle
Create policy on how xdocs should be written
Open
approved
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 4.2k
- Avg merge
- 22h 23m
- Merged PRs (30d)
- 232
Description
Taken from https://github.com/checkstyle/checkstyle/pull/6782#discussion_r288070286 ,
Right now, alot of xdocs are very old and we are reworking them with the 'alignment' and other issues.
There should be some policy to clarify where to put examples on how good xdocs should be written when providing updates.
Maybe this could be somewhere on the contribution page. Brief description with relevant examples for existing checks would be great to make it easier to understand relevant requirements.
Contributor guide
Assessment
This issue has not been assessed yet.