ihatemoney/docs
zorun e458da954d
Reorganize "Contributing" documentation to be more accessible to new contributors (#573)
* Reorganize "Contributing" documentation to be more accessible to new contributors

The following changes were done:

- move "How to contribute" first, and "Set up a dev environment" as the
  second section.  This way, a new contributor has access to the most
  general information first, instead of the very specific "dev
  environment" documentation.

- reduce "How to contribute" / "As a developer" by moving the part about
  tests to a new "Contributing as a developer" section (see below).  This
  way, all types of contributions get roughly the same amount of text in
  the first "How to contribute" section.

- add a new "Contributing as a developer" section, which lists items that
  are useful when preparing a code contribution (running tests, formatting
  code, create database migration).  These items were moved either from
  "How to contribute" or from "Set up a dev environment".

* Add brief documentation about updating and adding tests

Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
2020-04-25 11:49:50 +02:00
..
api.rst Clean and reorganise a bit the documentation 2019-09-06 22:35:41 +02:00
conf.py Remove obsolete python code (<3.6). (#571) 2020-04-24 12:32:52 +02:00
configuration.rst Enhance postgresql installation docs. 2019-10-11 19:52:15 +02:00
contributing.rst Reorganize "Contributing" documentation to be more accessible to new contributors (#573) 2020-04-25 11:49:50 +02:00
index.rst Misc small updates (#536) 2020-02-23 19:27:39 +01:00
installation.rst Update install docs. 2020-04-24 15:22:37 +02:00
make.bat Document the API. Fix #46 2011-10-18 23:26:13 +02:00
Makefile Document the API. Fix #46 2011-10-18 23:26:13 +02:00
requirements.txt Update docs requirements sphinx and docutils. 2020-04-21 10:34:14 +02:00
upgrade.rst Clean and reorganise a bit the documentation 2019-09-06 22:35:41 +02:00