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

[Feature] Better documentation of internals #89

Open
skyzyx opened this issue Jan 3, 2021 · 0 comments
Open

[Feature] Better documentation of internals #89

skyzyx opened this issue Jan 3, 2021 · 0 comments

Comments

@skyzyx
Copy link

skyzyx commented Jan 3, 2021

What feature or capability would you like?

Better documentation around the internal flow of the software. Essentially something written from the perspective that I'm a new member of your software development team, and I need to ramp-up and become productive quickly. Assume I'm smart and understand Golang and JSON Schema, but don't know anything about this specific piece of software.

I've seen CONTRIBUTING.md and DEVELOPERS.md, but neither of them appear to be this (they're mostly process-oriented).

Do you have any examples of similar features in other software?

Thanks!

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

No branches or pull requests

1 participant