headers
Ralf Gommers | 14 Apr 2012 10:56
Gravatar

Contributing to SciPy guide

Hi all,

It has been pointed out by a number of people that it's not so easy to get started with contributing to SciPy, and better documentation may help here. So I've written a guide for this. It would be great to get some feedback especially from people who've found it difficult to find this information before. And if you haven't contributed before but were thinking about doing so, perhaps this is a good opportunity to get started!

Pull Request: https://github.com/scipy/scipy/pull/191
Rendered guide: https://github.com/rgommers/scipy/blob/howto-contribute/doc/HOWTO_CONTRIBUTE.rst.txt

Cheers,
Ralf

_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |
headers
Tim Cera | 14 Apr 2012 13:59

Re: Contributing to SciPy guide

This is a fantastic document. Thanks!  The only thing that occurred to me that was missing was a section on licensing issues.

Kindest regards,
Tim

On Apr 14, 2012 4:57 AM, "Ralf Gommers" <ralf.gommers <at> googlemail.com> wrote:
Hi all,

It has been pointed out by a number of people that it's not so easy to get started with contributing to SciPy, and better documentation may help here. So I've written a guide for this. It would be great to get some feedback especially from people who've found it difficult to find this information before. And if you haven't contributed before but were thinking about doing so, perhaps this is a good opportunity to get started!

Pull Request: https://github.com/scipy/scipy/pull/191
Rendered guide: https://github.com/rgommers/scipy/blob/howto-contribute/doc/HOWTO_CONTRIBUTE.rst.txt

Cheers,
Ralf


_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev

_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |
headers
Ralf Gommers | 15 Apr 2012 10:41
Gravatar

Re: Contributing to SciPy guide



On Sat, Apr 14, 2012 at 1:59 PM, Tim Cera <tim <at> cerazone.net> wrote:

This is a fantastic document. Thanks!  The only thing that occurred to me that was missing was a section on licensing issues.

Thanks Tim, that's a very good point. I added some info on licensing issues and a link to http://www.scipy.org/License_Compatibility

Ralf

 
On Apr 14, 2012 4:57 AM, "Ralf Gommers" <ralf.gommers <at> googlemail.com> wrote:
Hi all,

It has been pointed out by a number of people that it's not so easy to get started with contributing to SciPy, and better documentation may help here. So I've written a guide for this. It would be great to get some feedback especially from people who've found it difficult to find this information before. And if you haven't contributed before but were thinking about doing so, perhaps this is a good opportunity to get started!

Pull Request: https://github.com/scipy/scipy/pull/191
Rendered guide: https://github.com/rgommers/scipy/blob/howto-contribute/doc/HOWTO_CONTRIBUTE.rst.txt

Cheers,
Ralf


_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev


_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev


_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |
headers
Alexandre Gramfort | 15 Apr 2012 14:28
Picon
Picon
Favicon
Gravatar

Re: Contributing to SciPy guide

Dear Ralf,

thanks for this helpful document. What I think is missing is info and
link to pages that explain how to get started with a dev version of
scipy. Many users have a released version and have never compiled it
although they could be contributors. FAQ could be, how to work with a
dev version of scipy while keeping the last release to switch between
both? You can  find such info on the web but it might be worth
centralizing them. If it already exists, please let me know and forget
this message.

my 2c,

Alex

On Sat, Apr 14, 2012 at 10:56 AM, Ralf Gommers
<ralf.gommers <at> googlemail.com> wrote:
> Hi all,
>
> It has been pointed out by a number of people that it's not so easy to get
> started with contributing to SciPy, and better documentation may help here.
> So I've written a guide for this. It would be great to get some feedback
> especially from people who've found it difficult to find this information
> before. And if you haven't contributed before but were thinking about doing
> so, perhaps this is a good opportunity to get started!
>
> Pull Request: https://github.com/scipy/scipy/pull/191
> Rendered guide:
> https://github.com/rgommers/scipy/blob/howto-contribute/doc/HOWTO_CONTRIBUTE.rst.txt
>
> Cheers,
> Ralf
>
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev <at> scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
Permalink | Reply |
headers
Andreas H. | 15 Apr 2012 14:34
Picon

Re: Contributing to SciPy guide

> thanks for this helpful document. What I think is missing is info and
> link to pages that explain how to get started with a dev version of
> scipy. Many users have a released version and have never compiled it
> although they could be contributors. FAQ could be, how to work with a
> dev version of scipy while keeping the last release to switch between
> both? You can  find such info on the web but it might be worth
> centralizing them. If it already exists, please let me know and forget
> this message.

Good point, I think. I'm using a virtualenv for development, isolated 
from my system's site-packages. If you're interested, I can write a 
short paragraph about my setup and include it in the DOC.

Cheers,
Andreas.
I'm
Permalink | Reply |
headers
Alexandre Gramfort | 15 Apr 2012 14:35
Picon
Picon
Favicon
Gravatar

Re: Contributing to SciPy guide

> Good point, I think. I'm using a virtualenv for development, isolated
> from my system's site-packages. If you're interested, I can write a
> short paragraph about my setup and include it in the DOC.

that would be really useful.

Alex
Permalink | Reply |
headers
Ralf Gommers | 15 Apr 2012 23:10
Gravatar

Re: Contributing to SciPy guide



On Sun, Apr 15, 2012 at 2:35 PM, Alexandre Gramfort <alexandre.gramfort <at> inria.fr> wrote:
> Good point, I think. I'm using a virtualenv for development, isolated
> from my system's site-packages. If you're interested, I can write a
> short paragraph about my setup and include it in the DOC.

that would be really useful.

Sounds good. If you could describe the virtualenv setup Andreas, and I'll add a description of using an in-place build, plus when to use which, then that should cover the basics.

Ralf

_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |
headers
Ralf Gommers | 17 Apr 2012 23:39
Gravatar

Re: Contributing to SciPy guide



On Sun, Apr 15, 2012 at 11:10 PM, Ralf Gommers <ralf.gommers <at> googlemail.com> wrote:


On Sun, Apr 15, 2012 at 2:35 PM, Alexandre Gramfort <alexandre.gramfort <at> inria.fr> wrote:
> Good point, I think. I'm using a virtualenv for development, isolated
> from my system's site-packages. If you're interested, I can write a
> short paragraph about my setup and include it in the DOC.

that would be really useful.

Sounds good. If you could describe the virtualenv setup Andreas, and I'll add a description of using an in-place build, plus when to use which, then that should cover the basics.

This should also be described in http://docs.scipy.org/doc/numpy/dev/gitwash/, but unfortunately it doesn't. The instructions on sending patches are also really outdated, they still recommend to attached patches to a Trac ticket. In case you've read that doc, *please don't do that*. Send a pull request on Github instead.

<at> Matthew: should this also be fixed in https://github.com/matthew-brett/gitwash?

Ralf


_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |
headers
Andreas H. | 19 Apr 2012 11:52
Picon

Re: Contributing to SciPy guide

Am Di 17 Apr 2012 23:39:10 CEST schrieb Ralf Gommers:
>
>
> On Sun, Apr 15, 2012 at 11:10 PM, Ralf Gommers
> <ralf.gommers <at> googlemail.com <mailto:ralf.gommers <at> googlemail.com>> wrote:
>
>
>
>     On Sun, Apr 15, 2012 at 2:35 PM, Alexandre Gramfort
>     <alexandre.gramfort <at> inria.fr <mailto:alexandre.gramfort <at> inria.fr>>
>     wrote:
>
>         > Good point, I think. I'm using a virtualenv for development,
>         isolated
>         > from my system's site-packages. If you're interested, I can
>         write a
>         > short paragraph about my setup and include it in the DOC.
>
>         that would be really useful.
>
>
>     Sounds good. If you could describe the virtualenv setup Andreas,
>     and I'll add a description of using an in-place build, plus when
>     to use which, then that should cover the basics.
>
>
> This should also be described in
> http://docs.scipy.org/doc/numpy/dev/gitwash/, but unfortunately it
> doesn't.

I wrote up a short tutorial about using virtualenv and placed it here:

   https://gist.github.com/2419961

Should I incorporate it into the gitwash docs and send a PR to numpy?

Andreas.
Permalink | Reply |
headers
Ralf Gommers | 21 Apr 2012 10:52
Gravatar

Re: Contributing to SciPy guide



On Thu, Apr 19, 2012 at 11:52 AM, Andreas H. <lists <at> hilboll.de> wrote:
Am Di 17 Apr 2012 23:39:10 CEST schrieb Ralf Gommers:
>
>
> On Sun, Apr 15, 2012 at 11:10 PM, Ralf Gommers
> <ralf.gommers <at> googlemail.com <mailto:ralf.gommers <at> googlemail.com>> wrote:
>
>
>
>     On Sun, Apr 15, 2012 at 2:35 PM, Alexandre Gramfort
>     <alexandre.gramfort <at> inria.fr <mailto:alexandre.gramfort <at> inria.fr>>
>     wrote:
>
>         > Good point, I think. I'm using a virtualenv for development,
>         isolated
>         > from my system's site-packages. If you're interested, I can
>         write a
>         > short paragraph about my setup and include it in the DOC.
>
>         that would be really useful.
>
>
>     Sounds good. If you could describe the virtualenv setup Andreas,
>     and I'll add a description of using an in-place build, plus when
>     to use which, then that should cover the basics.
>
>
> This should also be described in
> http://docs.scipy.org/doc/numpy/dev/gitwash/, but unfortunately it
> doesn't.

I wrote up a short tutorial about using virtualenv and placed it here:

  https://gist.github.com/2419961

Should I incorporate it into the gitwash docs and send a PR to numpy?

That sounds good. I can link to it from the FAQ of the contributors guide then.

Ralf
_______________________________________________
SciPy-Dev mailing list
SciPy-Dev <at> scipy.org
http://mail.scipy.org/mailman/listinfo/scipy-dev
Permalink | Reply |

Gmane