-
Notifications
You must be signed in to change notification settings - Fork 35
Improve contributing docs #125
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
Comments
@jerowe @daletovar @timothymillar would love your input on what we need to add/remove/change in our contributing docs. |
On https://pystatgen.github.io/sgkit/contributing.html#issues it already says,
But it should be changed to say to mention the issue in the PR comments. |
The docs seem to cover most things without being to long which is great (I should have read up on pre-commit a bit more before #114). It may be good to have some explicit examples on how and when to include array shape and type information within a docstring. I also like to look at past accepted PR's and It could be useful to highlight an exemplar PR in the contributing guide. |
@jeromekelleher mentioned in the last developer call that he had a guide from another project that could be useful to link from our documentation. There's also been some discussion in #129 and #140 on the use of branches in developer forks and how to keep those branches up to date. Do we need to add some text to our contributing docs to reflect the consensus from those issues? |
Also I believe https://github.com/pystatgen/sgkit/issues/216 addresses the docstring style task above. |
@tomwhite do we need to augment the contributing docs to ensure we don't miss functions when building the Sphinx docs as in https://github.com/pystatgen/sgkit/issues/212? |
I see #212 is closed, but I still don't see
The instructions for the same does seems to be fixing here: https://pystatgen.github.io/sgkit/contributing.html#docstrings
I have made a comment here on my understanding of the same: https://github.com/pystatgen/sgkit/issues/216#issuecomment-688964428 Let me know, if these makes sense, I will open a PR for the same. |
Uh oh!
There was an error while loading. Please reload this page.
A few things missing:
The text was updated successfully, but these errors were encountered: