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
FAQ: Contributions Welcome #6061
Comments
I'm trying to find the log of docstrings not up to standard you mention but I don't see it, can you clarify? |
If you look at the output of a docbuild run such as https://travis-ci.org/github/statsmodels/statsmodels/jobs/732588884 and then search for Checking Doc Strings You will see a long list of docstrings that have missing variables or other issues. |
The most important types look like
and
since there are variables that are not defined or are most likely misnamed. |
I clicked this link, but it says doesn't exist, also: travis CI switched from .org to .com. So just asking the same question :) |
Contributing
statsmodels
welcomes contributions of all sizes, including:docstring fixes, which can be very small
Documentation is hard, and many eyes help fix typos, missing parameters, and many other issues. We are always happy to accept docstring improvements. The doc builds on Travis CI contains a log of docstrings that aren't up to standards (about 6000 issues at the time of writing). Improvements to these are especially welcome.
notebooks
Examples are incredibly useful. If you have a written a notebook that highlights using
sm
in ways that are not already covered in examples, please share these to improve the documentation.bug fixes
Bug fixes are always welcome. There are plenty of opportunities on the issue tracker to contribute.
enhancements
statsmodels
is community-driven, and so enhancements are welcome. Large enhancements, for example, new models should:Smaller enhancements, for example, a new option on an existing method, are also welcome. More minor enhancements have a lower bar and should:
cleaning
Pure code clean-ups are generally discouraged. (Locally) cleaning up code as part of contributing to one of the other goals is encouraged.
The text was updated successfully, but these errors were encountered: