aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.rst
AgeCommit message (Collapse)AuthorFilesLines
2020-07-26Use venv module rather than virtualenvJocelyn Delalande1-2/+2
- simpler to use - lighter dependency (or no dependency at all, depending on python distribution) - retrocompatible virtualenv package from pip to acheive virtual environment feature is no longer needed, except for projects which need to support py2, which is no longer our case. Also, reword "virtualenv" to "virtual environment" in doc, to avoid confusion with pip package name. Ref #483
2020-04-25Fix sqlite only migration. (#579)Rémy HUBSCHER1-1/+1
2020-04-25Reorganize "Contributing" documentation to be more accessible to new ↵zorun1-66/+99
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-24Improve documentation regarding database migrations (#569)zorun1-5/+20
2020-04-22Add a word about isort in the contributing docs. (#564)Rémy HUBSCHER1-5/+6
2020-04-21Update known working set. (#558)Rémy HUBSCHER1-4/+2
* Update known working set. * Pin dependencies in setup.cfg. * Cleanup Makefile. * Try the python_version trick.
2020-04-12Fix spelling (#552)Glandos1-1/+1
2020-04-12Spelling in documentation fixed, Weblate link (#551)Allan Nordhøy1-12/+12
2019-10-14Added better way to install ihatemoneyJosé Antonio de la Torre1-1/+1
2019-10-14Added install of ihatemoney module to documentationJosé Antonio de la Torre1-0/+1
2019-10-14Add instructions on how to run black in the contributing guideAlexis M1-1/+10
2019-10-07Add information on how to translate.Alexis M1-12/+9
Fixes #428.
2019-09-18Update translations to publish new point release.Alexis M1-0/+5
2019-09-06Clean and reorganise a bit the documentationAlexis M1-26/+24
2019-09-03add docs somewhereAdrien CLERC1-0/+5
2019-02-20Update contributing.rstRémy HUBSCHER1-1/+1
2019-01-03Provide basic math operations on bills (#413)Byron Ullauri1-1/+1
* allow basic math ops in amount field for bills form * docs: changing compile-translations to build-translations
2018-12-25Document database migrations0livd1-1/+16
Closes #390
2018-11-25Document `make release` magicJocelyn Delalande1-0/+4
I am a bit scared to use this magic command each time I have to. That is to reassure future me and future others :-).
2018-08-05Enhance translation tooling (#360)JocelynDelalande1-0/+16
* Add a `make update-translations` command To collect new strings to be translated from code. Totally cheated on @Glandos commands :-) Ref #336 Ref https://github.com/spiral-project/ihatemoney/issues/336#issue-322069517 * Document translation process Fix #336 * Drop noisy location comments from .po files Fix #339 * Drop .pot header As it serves no purpose with our translation workflow. .po header could be removed also, but pybabel has no option for that. Ref #339
2017-08-24Add doc building instructions (#263)JocelynDelalande1-0/+16
2017-08-20Streamline installation doc, now using pip (#252)JocelynDelalande1-1/+47
* Fix conf files to reflect module renaming Python module was renamed budget → ihatemoney (see #243 and 6923367). Now, "budget" relates to nothing. * Harmonize `APPLICATION_ROOT` doc with other settings * Fix link markup * Switch documentation to recomend pip over git - Update installation instruction - Clearly separate dev setup from installation - Some rewordings/section-ization by the way * Add a hint on how to find the static path This is a downside on the pip choice over git for installation. We will have to ease that a bit. By doc or by code, before next release. * Make the nginx deployment doc more accurate * Add a big fat warning about SECRET_KEY in doc
2017-06-21Re-organize the documentation (#223)Alexis Metaireau1-0/+76
* Re-organize the documentation * Fix encoding errors for python 2 * Document the dependencies. Fixes #199 * Add a make update command. Fixes #211