argoproj / argoproj/argo-workflows

Provide Godoc for all codebase

Open
#5,737 0 comments 4 reactions 0 assignees View on GitHub
area/contributing area/docs
Dominant language
Go
Stars
17k
Forks
3.7k
Avg merge
1d 20h
Merged PRs (30d)
138

Description

# 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 👍.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Go codebase and the linked Godoc guide to determine the intended documentation scope. Done should mean that the codebase has proper Godoc documentation for its files, making their purpose easier for beginners to understand.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.