openrewrite / openrewrite/rewrite
Ensure recipe marketplace ADR is accurate
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 3.7k
- Forks
- 570
- Avg merge
- 13h 12m
- Merged PRs (30d)
- 261
Description
Right now, the recipe marketplace CSV ADR has a couple of issues. There are columns that are listed as optional that aren't - and there is a column that need to have its names changed for clarity. We should ensure that this document is accurate and fix the code if it's wrong or does not match this ADR.
Columns that are marked as optional that shouldn't be
- displayName
- description
- recipeCount
- category1, category2, ..., categoryN
- category1Description, category2Description, ..., categoryNDescription
- options
Column to change
- team - proposed change would be to
organization
Related Slack thread
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
Start with doc/adr/0006-recipe-marketplace-csv-format.md and compare its required columns and naming with the code that produces the recipe marketplace CSV. Confirm the listed fields are no longer optional, assess the team-to-organization rename, and update the code if it disagrees. Done means the ADR and generated CSV format match; run the relevant project tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100