Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting debugging within Orval Project #1636

Closed
EduardoAC opened this issue Sep 22, 2024 · 0 comments · Fixed by #1637
Closed

Documenting debugging within Orval Project #1636

EduardoAC opened this issue Sep 22, 2024 · 0 comments · Fixed by #1637
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@EduardoAC
Copy link
Contributor

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

EduardoAC added a commit to EduardoAC/orval that referenced this issue Sep 22, 2024
- Refined instructions for running the development environment
- Added clarity to testing and troubleshooting sections
- Enhanced code examples for better IDE configuration
@melloware melloware added the documentation Improvements or additions to documentation label Sep 22, 2024
@melloware melloware added this to the 7.2.0 milestone Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants