|
| 1 | +======== |
| 2 | +dmriprep |
| 3 | +======== |
| 4 | + |
| 5 | + |
| 6 | +.. image:: https://img.shields.io/pypi/v/dmriprep.svg |
| 7 | + :target: https://pypi.python.org/pypi/dmriprep |
| 8 | + |
| 9 | +.. image:: https://img.shields.io/travis/akeshavan/dmriprep.svg |
| 10 | + :target: https://travis-ci.org/akeshavan/dmriprep |
| 11 | + |
| 12 | +.. image:: https://readthedocs.org/projects/dmriprep/badge/?version=latest |
| 13 | + :target: https://dmriprep.readthedocs.io/en/latest/?badge=latest |
| 14 | + :alt: Documentation Status |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +Preprocessing of neuroimaging data in preparation for AFQ analysis |
| 20 | + |
| 21 | + |
| 22 | +* Free software: BSD license |
| 23 | +* Documentation: https://dmriprep.readthedocs.io. |
| 24 | + |
| 25 | + |
| 26 | +Features |
| 27 | +-------- |
| 28 | + |
| 29 | +* TODO |
| 30 | + |
| 31 | + |
| 32 | +Contributing |
| 33 | +------------ |
| 34 | + |
| 35 | +We love contributions! dmriprep is open source, built on open source, |
| 36 | +and we'd love to have you hang out in our community. |
| 37 | + |
| 38 | +We have developed some `guidelines`_ for contributing to dmriprep. |
| 39 | + |
| 40 | +**Imposter syndrome disclaimer**: We want your help. No, really. |
| 41 | + |
| 42 | +There may be a little voice inside your head that is telling you that |
| 43 | +you're not ready to be an open source contributor; that your skills |
| 44 | +aren't nearly good enough to contribute. What could you possibly offer a |
| 45 | +project like this one? |
| 46 | + |
| 47 | +We assure you - the little voice in your head is wrong. If you can |
| 48 | +write code at all, you can contribute code to open source. Contributing |
| 49 | +to open source projects is a fantastic way to advance one's coding |
| 50 | +skills. Writing perfect code isn't the measure of a good developer (that |
| 51 | +would disqualify all of us!); it's trying to create something, making |
| 52 | +mistakes, and learning from those mistakes. That's how we all improve, |
| 53 | +and we are happy to help others learn. |
| 54 | + |
| 55 | +Being an open source contributor doesn't just mean writing code, either. |
| 56 | +You can help out by writing documentation, tests, or even giving |
| 57 | +feedback about the project (and yes - that includes giving feedback |
| 58 | +about the contribution process). Some of these contributions may be the |
| 59 | +most valuable to the project as a whole, because you're coming to the |
| 60 | +project with fresh eyes, so you can see the errors and assumptions that |
| 61 | +seasoned contributors have glossed over. |
| 62 | + |
| 63 | + |
| 64 | +Credits |
| 65 | +------- |
| 66 | + |
| 67 | +This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. |
| 68 | + |
| 69 | +The imposter syndrome disclaimer was originally written by `Adrienne |
| 70 | +Lowe`_ for a `PyCon talk`_, and was adapted based on its use in the |
| 71 | +README file for the `MetPy project`_. |
| 72 | + |
| 73 | +.. _Cookiecutter: https://github.com/audreyr/cookiecutter |
| 74 | +.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage |
| 75 | +.. _`Adrienne Lowe`: https://github.com/adriennefriend |
| 76 | +.. _`Pycom talk`: https://www.youtube.com/watch?v=6Uj746j9Heo |
| 77 | +.. _`MetPy project`: https://github.com/Unidata/MetPy |
| 78 | +.. _`guidelines`: CONTRIBUTING.rst |
0 commit comments