objectionary / objectionary/lints
The validity of Markdown in comments is not tested
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 14
- Forks
- 39
- Avg merge
- 22h 54m
- Merged PRs (30d)
- 90
Description
Let's introduce a new Lint, which will check the validity of formatting of comments: must be Markdown format. Maybe we can use something like this: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspace/api/markdown/MarkdownValidator.html
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
The issue names no files, tests, or entry points; start by reviewing the repository's existing lint structure and the proposed MarkdownValidator reference. Define how comment formatting is judged, add coverage for valid and invalid Markdown comments, and consider the work done when the new Lint reliably reports invalid comment formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, markdown
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100