From 914751be0f66672c2810976ee340a88bba4deb5d Mon Sep 17 00:00:00 2001 From: Menshikh Ivan Date: Fri, 15 Dec 2017 19:01:09 +0500 Subject: [PATCH 1/6] update contributing.md --- CONTRIBUTING.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd8f49ed4b..15d2d5bfff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,33 @@ -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 issue?** +------------------------ +First, 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. -Please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/wiki/Recipes-&-FAQ) page before posting. +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 new feature / create PR / etc?** +--------------------- + +1. Fork gensim repository +2. Clone your fork: `git clone https://github.com//gensim.git` +3. Create new branch based on develop: `git checkout -b my-feature develop` +4. Make all needed changes +4. Check that all OK in your branch (in needed): + - Check PEP8: `tox -e flake8` + - Build documentation (work only for MacOS/Linux): `tox -e docs` + - Run base tests: `tox -e py{version}-{os}`, for example `tox -e py27-linux` or `tox -e py36-win` where + - `{version}` from `27`, `35`, `36` and + - `{os}` from `win`, `linux` + +5. Add files, commit and push: `git add ... ; git commit -m "my commit message"; git push origin my-feature` +6. Create PR on github. Please add clear description for PR and add all needed information to first message, for example: + - Number of issue that you fixed, like `#123` + - Motivation (why and how) + - Any useful related information + - ... + + +P/S: for developers: see our [Developer Page](https://github.com/piskvorky/gensim/wiki/Developer-page#code-style) for details on code style, testing and similar. Thanks! From 2b4d9279bc0f86fcb928abb07a77749e814c6ca1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radim=20=C5=98eh=C5=AF=C5=99ek?= Date: Fri, 15 Dec 2017 15:18:35 +0100 Subject: [PATCH 2/6] fix language --- CONTRIBUTING.md | 44 ++++++++++++++++++++------------------------ 1 file changed, 20 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15d2d5bfff..8757c514a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,29 @@ -**How to submit issue?** ------------------------- -First, 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? + +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. -**How to add new feature / create PR / etc?** ---------------------- +# How to add a new feature or create a pull request? -1. Fork gensim repository +1. Fork the Gensim repository 2. Clone your fork: `git clone https://github.com//gensim.git` -3. Create new branch based on develop: `git checkout -b my-feature develop` -4. Make all needed changes -4. Check that all OK in your branch (in needed): - - Check PEP8: `tox -e flake8` - - Build documentation (work only for MacOS/Linux): `tox -e docs` - - Run base tests: `tox -e py{version}-{os}`, for example `tox -e py27-linux` or `tox -e py36-win` where - - `{version}` from `27`, `35`, `36` and - - `{os}` from `win`, `linux` - -5. Add files, commit and push: `git add ... ; git commit -m "my commit message"; git push origin my-feature` -6. Create PR on github. Please add clear description for PR and add all needed information to first message, for example: - - Number of issue that you fixed, like `#123` - - Motivation (why and how) - - Any useful related information - - ... - +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` + - 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` +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 code style, testing and similar. +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! From d6a956e1919a8479b908846928294324d32f419d Mon Sep 17 00:00:00 2001 From: Menshikh Ivan Date: Fri, 15 Dec 2017 22:31:39 +0500 Subject: [PATCH 3/6] Add info about enviroment --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8757c514a2..d7d3940046 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,15 +11,18 @@ Also, please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/ 1. Fork the Gensim repository 2. Clone your fork: `git clone https://github.com//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: +4. Setup your enviroment + - Create virtualenv: `pip install virtualenv; virtualenv new_env; source new_env/bin/activate` + - Install gensim test dependencies in editable mode: `pip install -e .[test]` +5. Implement your changes +6. 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` - 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` -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: +7. Add files, commit and push: `git add ... ; git commit -m "my commit message"; git push origin my-feature` +8. [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…) From 461ccf753a066fdf8401595a063c7b0f5550268a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radim=20=C5=98eh=C5=AF=C5=99ek?= Date: Fri, 15 Dec 2017 22:34:53 +0100 Subject: [PATCH 4/6] add links to CONTRIBUTING guide --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7d3940046..f4c9f6af87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,29 +4,29 @@ First, please see [contribution-guide.org](http://www.contribution-guide.org/) f 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. +**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. # How to add a new feature or create a pull request? 1. Fork the Gensim repository -2. Clone your fork: `git clone https://github.com//gensim.git` +2. Clone your fork: `git clone https://github.com//gensim.git` 3. Create a new branch based on `develop`: `git checkout -b my-feature develop` -4. Setup your enviroment - - Create virtualenv: `pip install virtualenv; virtualenv new_env; source new_env/bin/activate` - - Install gensim test dependencies in editable mode: `pip install -e .[test]` +4. Setup your Python enviroment + - Create a new [virtual environment](https://virtualenv.pypa.io/en/stable/): `pip install virtualenv; virtualenv gensim_env; source gensim_env/bin/activate` + - Install Gensim and its test dependencies in [editable mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs): `pip install -e .[test]` 5. Implement your changes 6. 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` - 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 + - `{version}` is one of `27`, `35`, `36` - `{os}` is either `win` or `linux` 7. Add files, commit and push: `git add ... ; git commit -m "my commit message"; git push origin my-feature` 8. [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…) + - The issue that you fixed, e.g. `Fixes #123` + - Motivation: why did you create this PR? What functionality did you set out to improve? What was the problem + an overview of how you fixed it? Whom does it affect 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 and let's improve the open source world together! +**Thanks and let's improve the open source world together!** From 8dc58d3253946f97088589780f354afdc6c030fb Mon Sep 17 00:00:00 2001 From: Menshikh Ivan Date: Sat, 16 Dec 2017 11:09:32 +0500 Subject: [PATCH 5/6] Add linux/win split --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4c9f6af87..b15adc3cfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,9 @@ Also, please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/ 3. Create a new branch based on `develop`: `git checkout -b my-feature develop` 4. Setup your Python enviroment - Create a new [virtual environment](https://virtualenv.pypa.io/en/stable/): `pip install virtualenv; virtualenv gensim_env; source gensim_env/bin/activate` - - Install Gensim and its test dependencies in [editable mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs): `pip install -e .[test]` + - Install Gensim and its test dependencies in [editable mode](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs): + - For linux: `pip install -e .[test]` + - For windows: `pip install -e .[test-win]` 5. Implement your changes 6. Check that everything's OK in your branch: - Check it for PEP8: `tox -e flake8` From 831da6014a594b5eac078de3845e4bfae5d157b6 Mon Sep 17 00:00:00 2001 From: Menshikh Ivan Date: Sat, 16 Dec 2017 11:13:56 +0500 Subject: [PATCH 6/6] add path where user can found documentation --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b15adc3cfc..a5db9ae27e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Also, please check the [Gensim FAQ](https://github.com/RaRe-Technologies/gensim/ 5. Implement your changes 6. 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` + - Build its documentation (works only for MacOS/Linux): `tox -e docs` (documentation stored in `docs/src/_build`) - 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` - `{os}` is either `win` or `linux`