orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺
When a new potential contributor wants to learn more about the codebase, there is not much information on how it can debug and better understand the codebase. Therefore, it makes it hard to onboard new people effectively.
What happens?
This triggers a chicken-and-egg situation within the project; people want to help support the project, but it can get overwhelming for new people. Therefore, providing additional documentation will help lower the learning curve and enable more people to participate in the project.
What were you expecting to happen?
We want to learn how to debug the codebase and how the project works effectively. We propose adding a simple DEBUGGING.md initial document to allow people to try things themselves.
What are the steps to reproduce this issue?
When a new potential contributor wants to learn more about the codebase, there is not much information on how it can debug and better understand the codebase. Therefore, it makes it hard to onboard new people effectively.
What happens?
This triggers a chicken-and-egg situation within the project; people want to help support the project, but it can get overwhelming for new people. Therefore, providing additional documentation will help lower the learning curve and enable more people to participate in the project.
What were you expecting to happen?
We want to learn how to debug the codebase and how the project works effectively. We propose adding a simple DEBUGGING.md initial document to allow people to try things themselves.
What versions are you using?
Version of Orval: 7.1.1