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

Provide Godoc for all codebase #5737

Open
sujaykulkarn opened this issue Apr 22, 2021 · 0 comments
Open

Provide Godoc for all codebase #5737

sujaykulkarn opened this issue Apr 22, 2021 · 0 comments
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix area/docs Incorrect, missing, or mistakes in docs type/feature Feature request

Comments

@sujaykulkarn
Copy link

sujaykulkarn commented Apr 22, 2021

Summary

What change needs making?

Right now, In the argo-workflows codebase, there is no proper documentation of the file and it becomes difficult for beginners to identify what that particular file does so it will be good if this godoc enhancement we do it.

Use Cases

When would you use this?
This helps contributors to get more out of the codebase and eventually helps in the development of argo-workflows.
For beginners like me, I am having a hard time understanding codebase as there are a lot of files involved and the contributor workshop video helped a lot but it is 11 months old session, Many things have changed in 11 months so this need arisen.
https://blog.golang.org/godoc#:~:text=Godoc%20is%20conceptually%20related%20to,syntax%20(as%20with%20Javadoc).

Please have a look and if it is a good proposal then provide inputs and also 👍, Thank you.


Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍.

@sujaykulkarn sujaykulkarn added the type/feature Feature request label Apr 22, 2021
@alexec alexec added the area/docs Incorrect, missing, or mistakes in docs label Feb 7, 2022
@agilgur5 agilgur5 added the area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix label Oct 16, 2024
@agilgur5 agilgur5 changed the title [PROPOSAL] Provide Godoc for all the codebase in the argo-workflows. Provide Godoc for all codebase Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix area/docs Incorrect, missing, or mistakes in docs type/feature Feature request
Projects
None yet
Development

No branches or pull requests

3 participants