scikit-image/scikit-image — pull request #399 by mkcor (2012-12-20 15:11:29+00:00)
Title: Doc fixes on first elements about contributing

Hello,

To suggest these few changes, I was inspired by my own experience as a beginner with `scikit-image`, Git and GitHub.

When looking for directions in the contribution world, I first stumbled across https://github.com/scikit-image/scikit-image/blob/master/DEVELOPMENT.txt : I didn't realize immediately it was a portion of Sphinx source for the online doc, so the first piece of advice (`Read this overview `) looked cryptic and left me helpless. That's why I added the actual URL (line 18 of DEVELOPMENT.txt). It may look redundant/awkward online, but it may help readers on GitHub. Better twice than never, don't you think? I can say that viewing this URL would have spared me some time and stress. ;)

Only recently did I realize that the gitwash thing came from a project per se: https://github.com/matthew-brett/gitwash
I'm just thinking this could be mentioned/credited, but it may not be super hyper important for now.

Regarding a detail of style, I converted the few "git/github" to "Git/GitHub". I have no personal preference: on one hand, "Git/GitHub" seems more proper but, on the other hand, "git/github" is easier and this is the spelling used there for instance (https://github.com/matthew-brett/gitwash).
So my only motivation lied in self-consistency: the page http://scikit-image.org/docs/dev/contribute.html displays mostly "Git/GitHub" so I considered it the standard. I'm afraid that the pages which follow have mostly "git/github" though...

I upgraded "Guidelines", "Stylistic Guidelines", etc. to the same hierarchy level as "Development process" because really they are not subsections of the development process... They are just other items to be aware of when willing to contribute.

I changed the ordering of a few items with a first-time reader in mind. Again, it is only based on my personal experience when trying to find out how to proceed.

My other changes are very minor and stylistic so I don't believe I need to discuss them. But feel free to give any feedback of course.

All the best,
Marianne