-
Notifications
You must be signed in to change notification settings - Fork 4
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
Comments
Revamping riotpot with latest changes
Hello sir,I am new to open source ,I find some good first issue ,is this assign to any one. |
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. |
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
The text was updated successfully, but these errors were encountered: