Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/SolutionsCloud/apidoc/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” is open to whoever wants to implement it.
ApiDoc could always use more documentation, whether as part of the official ApiDoc docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/SolutionsCloud/apidoc/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Setting Up the Code for Local Development¶
Here’s how to set up ApiDoc for local development.
- Fork the ApiDoc repo on GitHub.
- Clone your fork locally
$ git clone firstname.lastname@example.org:your_name_here/apidoc.git
- Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development
$ mkvirtualenv apidoc $ cd apidoc/ $ pip install -e .[contribute]
- Create a branch for local development
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
- When you’re done making changes, check that your changes pass the tests and flake8
$ flake8 --show-source --ignore=E501 --statistics . $ python setup.py test
- Commit your changes and push your branch to GitHub
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
- Check that the test coverage hasn’t dropped
$ behave --format progress2 tests/features/ $ coverage3 run --branch --source apidoc setup.py test $ coverage3 report -m
- Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 3.2, 3.3. Check https://travis-ci.org/SolutionsCloud/apidoc/pull_requests and make sure that the tests pass for all supported Python versions.
To run a particular test
$ python -m unittest tests.test_find.TestFind.test_find_template
To run a subset of tests
$ python -m unittest tests.test_find