-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Update contributing guide. Fix #1786 #1793
Changes from 2 commits
914751b
2b4d927
d6a956e
461ccf7
8dc58d3
831da60
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,29 @@ | ||
Please see [contribution-guide.org](http://www.contribution-guide.org/) for steps we expect from contributors before submitting an issue or bug report. Be as concrete as possible, include relevant logs, package versions etc. | ||
# How to submit an issue? | ||
|
||
Please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/wiki/Recipes-&-FAQ) page before posting. | ||
First, please see [contribution-guide.org](http://www.contribution-guide.org/) for the steps we expect from contributors before submitting an issue or bug report. Be as concrete as possible, include relevant logs, package versions etc. | ||
|
||
Also, please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/wiki/Recipes-&-FAQ) page before posting. | ||
|
||
**The proper place for open-ended questions is the [gensim mailing list](https://groups.google.com/forum/#!forum/gensim).** Github is not the right place for research discussions or feature requests. | ||
|
||
For developers: see our [Developer Page](https://github.com/piskvorky/gensim/wiki/Developer-page#code-style) for details on code style, testing and similar. | ||
# How to add a new feature or create a pull request? | ||
|
||
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 | ||
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` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No docs for Windows? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, never was. |
||
- 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` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No testing for OSX? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably |
||
6. Add files, commit and push: `git add ... ; git commit -m "my commit message"; git push origin my-feature` | ||
7. [Create a PR](https://help.github.com/articles/creating-a-pull-request/) on Github. Write a **clear description** for your PR, including all the context and relevant information, such as: | ||
- The number of the issue that you fixed, e.g. `Fixes #123` | ||
- Motivation (why did you create this PR, what functionality does it seek to improve, what was the problem + an overview of how you fixed it, whom does it help and how should people use it…) | ||
- Any other useful information (links to other related Github or mailing list issues and discussions, benchmark graphs, academic papers…) | ||
|
||
P.S. for developers: see our [Developer Page](https://github.com/piskvorky/gensim/wiki/Developer-page#code-style) for details on the Gensim code style, CI, testing and similar. | ||
|
||
Thanks! | ||
Thanks and let's improve the open source world together! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Python work environment? Dependencies?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed d6a956e