Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
@mwcraig some updates to the README on contributing to hopefully be more helpful to new contributors.   Thoughts?   Feel free to also merge and then update. according or I can update any additions tomorrow.
  • Loading branch information
crawfordsm committed Mar 16, 2016
1 parent f912ade commit d10e1e4
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.rst
Expand Up @@ -20,15 +20,26 @@ Ccdproc can currently be installed via pip or from the source code. For
installation instructions, see the `online documentation`_ or docs/install.rst
in this source distribution.

This package is a work in progress...feel free to help out by picking an issue
and working on it!

Documentation is at `ccdproc.readthedocs.org
<http://ccdproc.readthedocs.org/en/latest/>`_

## Contributing

We have had the first stable release, but there is still plenty to do!

Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. New contributions and contributors are very welcome!

New to github or open source projects? If you are unsure about where to start or haven't used github before, please feel free to email `@crawfordsm`_ or `@mwcraig`_ . We will more than happily help you make your first contribution.

Feedback and feature requests? Is there something missing you would like to see? Please open an issue or send an email to `@mwcraig`_ or `@crawfordsm`_.

Ccdproc follows the `Astropy Code of Conduct`_ and strives to provide a welcoming community to all of our users and contributors.

## Acknowledgements

If you have found ccdproc useful to your research, please considering adding a
citation to `ccdproc contributors; Craig, M. W.; Crawford, S. M.; Deil, Christoph; Gasdia, Forrest; Gomez, Carlos; Günther, Hans Moritz; Heidt, Nathan; Horton, Anthony; Karr, Jennifer; Nelson, Stefan; Ninan, Joe Phillip; Pattnaik, Punyaslok; Rol, Evert; Schoenell, William;
Seifert, Michael; Singh, Sourav; Sipocz, Brigitta; Stotts, Connor; Streicher, Ole; Tollerud, Erik; and Walker, Nathan, 2015, Astrophysics Source Code Library, 1510.007, DOI: 10.5281/zenodo.47652 <http://adsabs.harvard.edu/abs/2015ascl.soft10007C>`_
citation to `ccdproc contributors; Craig, M. W.; Crawford, S. M.; Deil, Christoph; Gasdia, Forrest; Gomez, Carlos; Günther, Hans Moritz; Heidt, Nathan; Horton, Anthony; Karr, Jennifer; Nelson, Stefan; Ninan, Joe Phillip; Pattnaik, Punyaslok; Rol, Evert; Schoenell, William; Seifert, Michael; Singh, Sourav; Sipocz, Brigitta; Stotts, Connor; Streicher, Ole; Tollerud, Erik; and Walker, Nathan, 2015, Astrophysics Source Code Library, 1510.007, DOI: 10.5281/zenodo.47652 <http://adsabs.harvard.edu/abs/2015ascl.soft10007C>`_

Thanks to Kyle Barbary (`@kbarbary`_) for designing the `ccdproc` logo.

Expand All @@ -38,3 +49,6 @@ Thanks to Kyle Barbary (`@kbarbary`_) for designing the `ccdproc` logo.
.. _Cython: http://cython.org/
.. _online documentation: http://ccdproc.readthedocs.org/en/latest/ccdproc/install.html
.. _@kbarbary: https://github.com/kbarbary
.. _@crawfordsm: https://github.com/crawfordsm
.. _@mwcraig: https://github.com/mwcraig
.. _Astropy Code of Conduct: http://www.astropy.org/about.html#codeofconduct

0 comments on commit d10e1e4

Please sign in to comment.