Update contributing guide. Fix #1786 #1793
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
piskvorky
reviewed
Dec 15, 2017
CONTRIBUTING.md
Outdated
| 1. <a href="https://github.com/RaRe-Technologies/gensim/fork">Fork the Gensim repository</a> | ||
| 2. Clone your fork: `git clone https://github.com/<USERNAME>/gensim.git` | ||
| 3. Create a new branch based on `develop`: `git checkout -b my-feature develop` | ||
| 4. Implement your changes |
Owner
There was a problem hiding this comment.
Python work environment? Dependencies?
| - Build its documentation (works only for MacOS/Linux): `tox -e docs` | ||
| - Run unit tests: `tox -e py{version}-{os}`, for example `tox -e py27-linux` or `tox -e py36-win` where | ||
| - `{version}` is one of `27`, `35`, `36` and | ||
| - `{os}` is either `win` or `linux` |
Contributor
Author
There was a problem hiding this comment.
Probably linux should works fine for macOS (but I can't test it)
CONTRIBUTING.md
Outdated
| 4. Implement your changes | ||
| 5. Check that everything's OK in your branch: | ||
| - Check it for PEP8: `tox -e flake8` | ||
| - Build its documentation (works only for MacOS/Linux): `tox -e docs` |
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.
Fix #1786