diff --git a/doc/development/contribution/general.rst b/doc/development/contribution/general.rst new file mode 100644 index 000000000..bcbcf4b0a --- /dev/null +++ b/doc/development/contribution/general.rst @@ -0,0 +1,36 @@ +General remarks +=============== + +You are interesting in contributing to pretix? That is awesome! + +If you’re new to contributing to open source software, don’t be afraid. We’ll happily review your code and give you +constructive and friendly feedback on your changes. + +First of all, you'll need pretix running locally on your machine. Head over to :ref:`devsetup` to learn how to do this. +If you run into any problems on your way, please do not hesitate to ask us anytime! + +Sending a patch +--------------- + +If you improved pretix in any way, we'd be very happy if you contribute it +back to the main code base! The easiest way to do so is to `create a pull request`_ +on our `GitHub repository`_. + +Before you do so, please `squash all your changes`_ into one single commit. Please +use the test suite to check whether your changes break any existing features and run +the code style checks to confirm you are consistent with pretix' coding style. You'll +find instructions on this in the :ref:`checksandtests` section of the development setup guide. + +We automatically run the tests and the code style check on every pull request on Travis CI and we won’t +accept any pull requets without all tests passing. However, if you don't find out *why* they are not passing, +just send the pull request and tell us – we'll be glad to help. + +If you add a new feature, please include appropriate documentation into your patch. If you fix a bug, +please include a regression test, i.e. a test that fails without your changes and passes after applying your changes. + +Again: If you get stuck, do not hesitate to contact any of us, or Raphael personally at mail@raphaelmichel.de. + + +.. _create a pull request: https://help.github.com/articles/creating-a-pull-request/ +.. _GitHub repository: https://github.com/pretix/pretix +.. _squash all your changes: https://davidwalsh.name/squash-commits-git \ No newline at end of file diff --git a/doc/development/contribution/index.rst b/doc/development/contribution/index.rst new file mode 100644 index 000000000..0e3f1b14e --- /dev/null +++ b/doc/development/contribution/index.rst @@ -0,0 +1,8 @@ +Contribution guide +================== + +.. toctree:: + :maxdepth: 2 + + general + style diff --git a/doc/development/style.rst b/doc/development/contribution/style.rst similarity index 100% rename from doc/development/style.rst rename to doc/development/contribution/style.rst diff --git a/doc/development/index.rst b/doc/development/index.rst index 97984d822..100dc56db 100644 --- a/doc/development/index.rst +++ b/doc/development/index.rst @@ -8,8 +8,8 @@ Contents: concepts setup - style structure + contribution/index models api/index diff --git a/doc/development/setup.rst b/doc/development/setup.rst index f544cfcf8..3cf780b5b 100644 --- a/doc/development/setup.rst +++ b/doc/development/setup.rst @@ -1,3 +1,5 @@ +.. _`devsetup`: + The development setup ===================== @@ -71,6 +73,8 @@ As we did not implement an overall front page yet, you need to go directly to http://localhost:8000/control/ for the admin view or, if you imported the test data as suggested above, to the event page at http://localhost:8000/mrmcd/2015/ +.. _`checksandtests`: + Code checks and unit tests ^^^^^^^^^^^^^^^^^^^^^^^^^^ Before you check in your code into git, always run the static checkers and unit tests::