[Biopython-dev] Adding a CONTRIBUTING.rst file for GitHub?

João Rodrigues j.p.g.l.m.rodrigues at gmail.com
Wed Apr 1 15:27:29 UTC 2015


Hi Peter,

Nice idea, didn't know such a file existed. I can have a look at it today.

Cheers,

João

Em qua, 1 de abr de 2015 às 17:20, Peter Cock <p.j.a.cock at googlemail.com>
escreveu:

> Dear Biopythoneers,
>
> Some of you may be aware of the GitHub convention of
> having a file name CONTRIBUTING (or CONTRIBUTING.md
> or I assume CONTRIBUTING.rst) in the root folder which gets
> shown to people automatically during a pull request etc:
>
> https://github.com/blog/1184-contributing-guidelines
>
> I think we should do this too, and can move/copy some
> of the content from the contributing chapter of the
> tutorial: Doc/Tutorial/chapter_contributing.tex
>
> Assuming it works, I would prefer CONTRIBUTING.rst since
> we already use restructured text for Python docstrings etc.
>
> Given this is a plain text file, we could include it in the
> source code releases (via the MANIFEST.in file).
>
> Does this seem like a good idea? Does anyone want to
> write a draft (based on the LaTeX file)?
>
> Thanks,
>
> Peter
>
> P.S. At this point, is *.rst widely used enough that we
> could simply rename README to README.rst (and
> get rid of the symlink used to get it rendered on the
> main GitHub page?)
> _______________________________________________
> Biopython-dev mailing list
> Biopython-dev at mailman.open-bio.org
> http://mailman.open-bio.org/mailman/listinfo/biopython-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.open-bio.org/pipermail/biopython-dev/attachments/20150401/f6bee48f/attachment.html>


More information about the Biopython-dev mailing list