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

"Contributing" #838

Merged
merged 5 commits into from Jan 21, 2016

Conversation

Projects
None yet
3 participants
@arokem
Member

arokem commented Jan 18, 2016

This file gets rendered by Github into PRs (https://github.com/blog/1184-contributing-guidelines) and should help newcomers figure out what/how/why to contribute. For the git procedure, I am directing them to the existing developer documentation, but this also covers some other points that we like to look for in our review. Am I forgetting anything important?

arokem added some commits Jan 18, 2016

DOC: Clean up Python 3 description a bit.
In particular, I think that statements like: "you already know" don't
belong in this document. If the reader already knows what we are
explaining, they probably wouldn't bother reading this in the first
place.
DOC: Adding a ``CONTRIBUTING`` document.
This will help contributors know what they need to look for when
writing code for dipy. For example, docstring, testing, and style
requirements.
### Documentation
We use [sphinx](http://www.sphinx-doc.org/en/stable/contents.html) for
documentation. We welocme contributions of examples, and suggestions for

This comment has been minimized.

@jchoude

jchoude Jan 18, 2016

Contributor

Typo in welcome

documentation. We welocme contributions of examples, and suggestions for
changes in the documentation, but please make sure that changes that are
introduced render properly into the html format that is used for the Dipy
website

This comment has been minimized.

@jchoude

jchoude Jan 18, 2016

Contributor

Missing the closing period.

@@ -25,22 +28,22 @@ As the first code line of the file, to use Python 3 behavior by default.
Print
*****
Yeah, you knew that, but use the ``__future__`` import above, and
``print(something)``
In Python 3, ``print`` is function. Please use the ``__future__`` import above,

This comment has been minimized.

@jchoude

jchoude Jan 18, 2016

Contributor

Missing an "a" between "is" and "function"?

@jchoude

This comment has been minimized.

Contributor

jchoude commented Jan 18, 2016

Seems like a good addition. Very nice to know that they now render this automatically!

@arokem

This comment has been minimized.

Member

arokem commented Jan 18, 2016

Thanks for taking a look! I fixed that typos you identified and also added
a sentence about the numpy docstring standard, which I forgot to mention
previously.

On Mon, Jan 18, 2016 at 7:01 AM, Jean-Christophe Houde <
notifications@github.com> wrote:

Seems like a good addition. Very nice to know that they now render this
automatically!


Reply to this email directly or view it on GitHub
#838 (comment).

Dipy is an open-source software project, and we have an open development
process. This means that we welcome contributions from anyone. We do ask that
you first read this document and follow the guidelines we have outlined here and
that you follow the [NIPY community code of conduct](http://nipy.org/conduct.html).

This comment has been minimized.

@Garyfallidis

Garyfallidis Jan 18, 2016

Member

Is this conduct inspired from somewhere or written from scratch?

This comment has been minimized.

@arokem

arokem Jan 18, 2016

Member

As it says, inspired by others and adapted for our needs. See nipy/nipy.github.com#1

### Supporting both Python 2 and 3
Most of the functionality in Dipy works on both Python 3 and Python 2. Please
follow the instructions [here](http://nipy.org/dipy/devel/python3.html) to

This comment has been minimized.

@Garyfallidis

Garyfallidis Jan 18, 2016

Member

You can write http://dipy.org/devel/...
We got the domain so we can make the links shorter. However, it's a bit puzzling that when someone writes dipy.org/devel we will get nipy.org/dipy/devel in his browser but maybe there is a way to fix this (from godaddy).

@@ -0,0 +1,89 @@
# Contributing to Dipy

This comment has been minimized.

@Garyfallidis

Garyfallidis Jan 18, 2016

Member

Thanx for starting to write such a document. Shouldn't this be an rst file in the dipy/doc folder?
Here you wrote a markdown file but we don't have any markdown documents in dipy. I have a feeling this is in the wrong format and possibly folder. This information should be rendered by sphinx or something in the docs. You can also have a copy in the setup.py folder but that is secondary.

This comment has been minimized.

@arokem

arokem Jan 18, 2016

Member

Fixed that other things as well. Thanks for taking a look!

On Mon, Jan 18, 2016 at 11:31 AM, Eleftherios Garyfallidis <
notifications@github.com> wrote:

In CONTRIBUTING
#838 (comment):

@@ -0,0 +1,89 @@
+# Contributing to Dipy

Thanx for starting to write such a document. Shouldn't this be an rst file
in the dipy/doc folder?
Here you wrote a markdown file but we don't have any markdown documents in
dipy. I have a feeling this is in the wrong format and possibly folder.
This information should be rendered by sphinx or something in the docs. You
can also have a copy in the setup.py folder but that is secondary.


Reply to this email directly or view it on GitHub
https://github.com/nipy/dipy/pull/838/files#r50035912.

@arokem

This comment has been minimized.

Member

arokem commented Jan 18, 2016

It's a markdown file, and at top level, so that it interoperates well with Github. See here: https://github.com/blog/1184-contributing-guidelines. TLDR: If there's a markdown file called CONTRIBUTING.md (or CONTRIBUTING) at top level, people get pointed to this file when they make a PR.

Garyfallidis added a commit that referenced this pull request Jan 21, 2016

@Garyfallidis Garyfallidis merged commit 383b4e5 into nipy:master Jan 21, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment