Skip to content
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

Add contributor information to developers wiki page #1786

Closed
datapythonista opened this issue Dec 13, 2017 · 1 comment
Closed

Add contributor information to developers wiki page #1786

datapythonista opened this issue Dec 13, 2017 · 1 comment
Labels
difficulty medium Medium issue: required good gensim understanding & python skills documentation Current issue related to documentation

Comments

@datapythonista
Copy link
Contributor

#1604 mentions that the developer documentation is outdated. Besides updating it, I think there is some information missing for contributors.

The main things I think are missing:

  • How to set up a developer environment
  • How to build Gensim
  • How to send a pull request following the git flow described in the page

While the information provided seems appropriate for core developers of the project, contributors sending pull requests would in my opinion require those additional sections.

Regarding the developer environment, I don't see a requirements.txt (or requirements-dev.txt) file that can be used to install it. I guess there are also other project requirements for the project, and it'd be nice to know how contributors are expected to set up those things.

About the git flow, I think it should be obvious for open source contributors how to send a pull request to master. But given that the pull requests need to be sent to develop, I think it'd be useful to have a short documentation on how the whole flow looks like. It's nicely documented for core developers who can push to the repo, but not for contributors sending pull requests.

May be it could be a good idea to have separate pages for core developers and external contributors. And may be move this content to the CONTRIBUTING.md page.

@menshikh-iv
Copy link
Contributor

Thanks for report @datapythonista, I regularly update doc, but more in "how to release" part.

I will try to fix this issue ASAP.

@menshikh-iv menshikh-iv added documentation Current issue related to documentation difficulty medium Medium issue: required good gensim understanding & python skills labels Dec 14, 2017
menshikh-iv added a commit that referenced this issue Dec 16, 2017
* update contributing.md

* fix language

* Add info about enviroment

* add links to CONTRIBUTING guide

* Add linux/win split

* add path where user can found documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty medium Medium issue: required good gensim understanding & python skills documentation Current issue related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants