openrewrite / openrewrite/rewrite
Add descriptions to the YAML schema
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 3.7k
- Forks
- 570
- Avg merge
- 13h 12m
- Merged PRs (30d)
- 261
Description
@knutwannheden suggested amending the schema to include descriptions for each of the keys so that the editor can display those descriptions. I think that's a great idea and something we should consider doing at some point.
This can potentially include HTML: https://www.jetbrains.com/help/idea/json.html#ws_json_show_doc_in_html
Contributor guide
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
No schema file, key list, or test is named in the issue. First locate the YAML schema and determine how editor descriptions are generated; done means the keys have descriptions that the editor can display, including any supported HTML behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100