-
-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add Docstrings #19
Comments
Hello, I found this issue by filtering through Github's issue list as this is my very first time at trying to find an open source contribution to make. Do I need to first authorise this contribution or can I simply create a fork and create a pull request with the added docstrings? One more thing as well is that if I am allowed to contribute are there any specific rules about which files you want me to add the docstrings to and how they should be structured? Thanks |
You can just create a fork and a PR with the added docstrings. You can add them to all the files, but I recommend that you do them on the files under the main folder and not the tests.(Also, module docstrings would be helpful). They should be in Google style. Also, I recommend doing it in multiple PR to make it easier to review. This will quicken the time it take to merge the PR. Thank you |
Also, could you star the repository so more people can see it? |
No description provided.
The text was updated successfully, but these errors were encountered: