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.

Sign up for GitHub

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

Jump to bottom

Align GoDoc with OpenShift API Conventions #383

Closed
everettraven opened this issue Sep 6, 2024 · 0 comments · Fixed by #390
Closed

Align GoDoc with OpenShift API Conventions #383

everettraven opened this issue Sep 6, 2024 · 0 comments · Fixed by #390
Assignees
@perdasilva
Labels
epic/catalogd-api-audit good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. v1.0 Issues related to the initial stable release of OLMv1

Comments

@everettraven
Copy link
Collaborator

As outlined in the Write User Readable Documentation in the GoDoc subsection of the OpenShift API Conventions, each field should be sufficiently documented such that an end user can answer:

  • What is the purpose of this field? What does it allow me to achieve?
  • How does this field interact with other fields or features?
  • What are the limitations of this field?
  • Is this field optional or required?
    • IF optional, what happens if the field is omitted?

GoDoc should also follow the Go comment standards outlined in https://tip.golang.org/doc/comment
@everettraven everettraven added v1.0 Issues related to the initial stable release of OLMv1 epic/catalogd-api-audit good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Sep 6, 2024
@perdasilva perdasilva self-assigned this Sep 9, 2024
@perdasilva perdasilva mentioned this issue Sep 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@perdasilva perdasilva

Labels
epic/catalogd-api-audit good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. v1.0 Issues related to the initial stable release of OLMv1
Projects
OLM v1
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

🌱 Align ClusterCatalog API godoc with OpenShift API conventions perdasilva/catalogd
2 participants
@perdasilva @everettraven