OpenAPITools / OpenAPITools/openapi-generator
[REQ] Split /samples into two directories
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
We should know which of the samples are 100% generated, and which have been manually modified. When a change is made, we should be able to delete and recreate those which are entirely generated.
I propose we have two directories, perhaps called samples and samples-generated. PRs should delete and build all in the samples-generated directory. PRs would not delete the samples directory but can still run generate and build the code.
Knowing what we can safely delete would make it easier to validate large changes. It would also ensure the tests in samples-generated stay current.
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 by inspecting the /samples directory and the generation and build workflow used by pull requests. Identify which samples are fully generated versus manually modified, then split them into the proposed directories. Done means generated samples can be deleted and recreated safely, while manually maintained samples remain available and the generated tests stay current.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100