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

Request for additional details in CONTRIBUTING.md #189

Closed
consideRatio opened this issue Mar 22, 2022 · 2 comments
Closed

Request for additional details in CONTRIBUTING.md #189

consideRatio opened this issue Mar 22, 2022 · 2 comments
Assignees
Labels
question Further information is requested

Comments

@consideRatio
Copy link
Contributor

consideRatio commented Mar 22, 2022

Before I observed a regression in v21 (#183) and were happy to see this didn't happen in v22 as well, but it left me curious to understand more how this codebase works which would also help me and others contribute to it.

Practically, I wondered if CONTRIBUTING.md could be enhanced with some more details to provide understanding about the code base's various parts. Some concrete things that I think could benefit from clarifications would be:

  • what is purely generated code and what isn't?

  • what adjustments have been made, and how have they been made technically?

    I'm thinking it could be: manual patches post-generation, automated post-generation patches, pre-generation configuration to influence the generation, etc.


Thanks you @tomplus for your work in this project! I'm very happy to see the v22 release and that releases are almost fully up to date with k8s releases!

@tomplus tomplus self-assigned this Mar 23, 2022
@tomplus tomplus added the question Further information is requested label Mar 23, 2022
@tomplus
Copy link
Owner

tomplus commented Apr 12, 2022

Thanks for your kind words.

I've updated the Contributing guide.

The generation process has to be fully automatic. No manual patches, I took shortcuts last time and we know how it's ended ;)

@consideRatio
Copy link
Contributor Author

Thank you @tomplus!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants