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

Use doc.go for documentation #1

Open
RicYaben opened this issue Jun 20, 2023 · 2 comments
Open

Use doc.go for documentation #1

RicYaben opened this issue Jun 20, 2023 · 2 comments

Comments

@RicYaben
Copy link
Collaborator

We should use the format doc.go to add descriptions to packages. This approach can be seen in bigger projects (e.g. Kubernetes) that start to see the complexities of the Golang project layout, and the Golang documentation official page Godoc

RicYaben added a commit that referenced this issue Jun 24, 2023
Revamping riotpot with latest changes
@Jagannathmaity110
Copy link

Hello sir,I am new to open source ,I find some good first issue ,is this assign to any one.

@RicYaben
Copy link
Collaborator Author

Hey there! You can take on the task if you want :) create your own fork of the project, and submit a pull request when you are ready. The project does not have a guideline on how to contribute, but we prefer that you submit verified commits to the issue. Because this issue does not imply any functionality (just documentation), you are welcome to commit directly to the main branch. However, I have to warn you that this issue requires somewhat deep knowledge of the application!

We expect the documentation to be written in American English, following the regular Golang guidelines.

@RicYaben RicYaben reopened this Sep 15, 2023
@RicYaben RicYaben changed the title Use go.doc for documentation Use doc.go for documentation Sep 17, 2023
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

2 participants