[yt-dev] Adding a CONTRIBUTING file

[Nathan Goldbaum]

On Sunday, November 8, 2015, Michael Zingale <michael.zingale at stonybrook.edu>
wrote:

> I think that this is a nice idea.
>
> It might also be good to have a list of "easy" projects that might be a
> way for someone new to yt to get a first contribution.  Obviously this
> would need to be kept up to date.  But I know that there are a lot of yt
> users who would like to give back if they knew where to help.
>

What I can do is link to a bitbucket search that filters out all of the
issues except for the ones marked "easy". We can also do a better job of
triaging issues regularly.


>
> On Sun, Nov 8, 2015 at 10:53 AM, Nathan Goldbaum <nathan12343 at gmail.com
> <javascript:_e(%7B%7D,'cvml','nathan12343 at gmail.com');>> wrote:
>
>> Hi all,
>>
>> I think a piece of low-hanging fruit to make the contributing process
>> clearer would be to add a CONTRIBUTING file to the main yt repository.
>>
>> I think the text of this file mostly exists already in this document in
>> the docs:
>>
>> http://yt-project.org/doc/developing/developing.html
>>
>> One thing I could do is extract the text of that document from the docs
>> sources and simply add it to the root of the repository like I've done with
>> the coding style guide in my open style PR. This way it's still in the docs
>> build (since it will be included using a sphinx include statement) but the
>> instructions will be closer to the code location in the root of the
>> repository, increasing discoverability for new contributors who are not
>> aware of the developer guide in the docs. This CONTRIBUTING file could also
>> subsume the coding_styleguide.txt file.
>>
>> This file could also summarize, discuss, and highlight the code of
>> conduct: http://ytep.readthedocs.org/en/latest/YTEPs/YTEP-0023.html
>>
>> Do others think this is a good idea? Are there other things that should
>> be in a CONTRIBUTING file. Maybe instead of copy/pasting the content of the
>> developing.rst file in the docs, it could just link to the developer guide,
>> and the discussion of the code of conduct and any other new things we'd
>> like to add could be added there.
>>
>> Thanks for your advice,
>>
>> Nathan
>>
>> _______________________________________________
>> yt-dev mailing list
>> yt-dev at lists.spacepope.org
>> <javascript:_e(%7B%7D,'cvml','yt-dev at lists.spacepope.org');>
>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>
>>
>
>
> --
> Michael Zingale
> Associate Professor
>
> Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY
> 11794-3800
> *phone*:  631-632-8225
> *e-mail*: Michael.Zingale at stonybrook.edu
> <javascript:_e(%7B%7D,'cvml','Michael.Zingale at stonybrook.edu');>
> *web*: http://www.astro.sunysb.edu/mzingale
> github: http://github.com/zingale
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-dev-spacepope.org/attachments/20151108/fce69694/attachment.html>