This isn't markdown\!
-# Contributing
+Contributing
+============
We want you to contribute to Hydroshare development, and we want you to be
as successful as possible in doing so. This document's aim is to provide you
with everything you need to succeed in your contributions.
-## Getting Started
+Getting Started
+---------------
-1. Fork the repo under your own name.
+1) Fork the repo under your own name
-2. Set up your Hydroshare development environment by following the directons
-[here](https://github.com/hydroshare/hydroshare#simplified-installation-instructions).
+2) Set up your Hydroshare development environment by following the
+`installation directions`_
-3. Make the required edits to the code.
+.. _installation directions: https://github.com/hydroshare/hydroshare#simplified-installation-instructions
-4. Push to your fork and [submit a pull request][pr].
+3) Make the required edits to the code
-[pr]: https://github.com/hydroshare/hydroshare/compare/
+4) Push to your fork and `submit a pull request`_
+
+.. _submit a pull request: https://github.com/hydroshare/hydroshare/compare/
+
+After You've Submitted a Pull Request
+-------------------------------------
The Hydroshare team varies in size and responsiveness over time. However, we try
to at least comment on pull requests within three business days (typically sooner).
@@ -23,10 +30,10 @@ to at least comment on pull requests within three business days (typically soone
We may suggest some changes or improvements or alternatives. Some things that will
increase the chance that your pull request is accepted:
-* Create an issue to pair your pull request with
-* Write tests.
-* Follow the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
-* Write a [good commit message][commit].
+- Create an issue to pair your pull request with
+- Write tests
+- Follow the `PEP8 style guide`_
+- Write a `good commit message`_
-[style]: https://github.com/thoughtbot/guides/tree/master/style
-[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
\ No newline at end of file
+.. _PEP8 style guide:: https://www.python.org/dev/peps/pep-0008/
+.. _good commit message: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
\ No newline at end of file
