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

Write an Architecture.md #1367

Open
Miles-Garnsey opened this issue Jul 11, 2024 · 0 comments
Open

Write an Architecture.md #1367

Miles-Garnsey opened this issue Jul 11, 2024 · 0 comments
Labels
enhancement New feature or request refactoring

Comments

@Miles-Garnsey
Copy link
Member

Miles-Garnsey commented Jul 11, 2024

What is missing?

We don't document code structure or what should be in pkg vs controllers (or why pkg even exists vs an internal dir). We also don't document what an envtest is, when to use one vs a e2e test or unit test, what the

Why do we need it?

This is an OSS project and we should enable new contributors with as much info as possible.

┆Issue is synchronized with this Jira Story by Unito
┆Issue Number: K8OP-11

@Miles-Garnsey Miles-Garnsey added enhancement New feature or request refactoring labels Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refactoring
Projects
No open projects
Status: No status
Development

No branches or pull requests

1 participant