Doc fixes & contributing guide #57
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
encukou
force-pushed
the
contributing
branch
from
0049a79 to
3b186ee
Compare
tiran
requested changes
Nov 29, 2017
Doc/contributing.rst
Outdated
| for checking things independent of the Python version: | ||
|
|
||
| * ``doc`` checks syntax and spelling of the documentation | ||
| * ``coverage`` generates a test coverage report |
There was a problem hiding this comment.
coverage-reportgenerates a test coverage report for Python code. It must be used as last test env, e.g.tox -e py27,py36,coverage-report.
Doc/contributing.rst
Outdated
| If you don't have some of them installed, you will get an | ||
| ``InterpreterNotFound`` error, which you can ignore:: | ||
|
|
||
| ERROR: py37: InterpreterNotFound: python3.7 |
There was a problem hiding this comment.
tox has skip_missing_interpreters, https://tox.readthedocs.io/en/latest/config.html#confval-skip_missing_interpreters=BOOL Wanna add it?
All you wanted to know about contributing to python-ldap! The refleak instructions from INSTALL are merged into contribution instructions. The file itself is made to link to installation instructions. Also add a CONTRIBUTING file that references the new text.
This directory is created using `make html`.
encukou
force-pushed
the
contributing
branch
from
3b186ee to
909c26b
Compare
tiran
approved these changes
Nov 29, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some documentation on how to contribute and maintain python-ldap.
Incidentally, this
Fixes: #50