mirror of
https://github.com/spiral-project/ihatemoney.git
synced 2025-04-28 17:32:38 +02:00
168 lines
4.5 KiB
ReStructuredText
168 lines
4.5 KiB
ReStructuredText
Contributing
|
|
############
|
|
|
|
Setup a dev environment
|
|
=======================
|
|
|
|
You must develop on top of the git master branch::
|
|
|
|
git clone https://github.com/spiral-project/ihatemoney.git
|
|
|
|
Then you need to build your dev environments. Choose your way…
|
|
|
|
The quick way
|
|
-------------
|
|
|
|
If System :ref:`installation-requirements` are fulfilled, you can just issue::
|
|
|
|
make serve
|
|
|
|
It will setup a `virtualenv <https://pypi.python.org/pypi/virtualenv>`_,
|
|
install dependencies, and run the test server.
|
|
|
|
The hard way
|
|
------------
|
|
|
|
Alternatively, you can also use the `requirements.txt` file to install the
|
|
dependencies yourself. That would be::
|
|
|
|
pip install -r requirements.txt
|
|
|
|
And then run the application::
|
|
|
|
cd ihatemoney
|
|
python run.py
|
|
|
|
Accessing dev server
|
|
--------------------
|
|
|
|
In any case, you can point your browser at `http://localhost:5000 <http://localhost:5000>`_.
|
|
It's as simple as that!
|
|
|
|
Updating
|
|
--------
|
|
|
|
In case you want to update to newer versions (from git), you can just run the "update" command::
|
|
|
|
make update
|
|
|
|
Create database migrations
|
|
--------------------------
|
|
|
|
In case you need to modify the database schema, first update the models in ihatemoney/models.py.
|
|
Then run the following command to create a new database revision file::
|
|
|
|
make create-database-revision
|
|
|
|
If your changes are simple enough, the generated script will be populated with
|
|
the necessary migrations steps.
|
|
For complex migrations, it is recommended to start from an empty revision file which can be created
|
|
with the following command::
|
|
|
|
make create-empty-database-revision
|
|
|
|
Useful settings
|
|
----------------
|
|
|
|
It is better to actually turn the debugging mode on when you're developing.
|
|
You can create a ``settings.cfg`` file, with the following content::
|
|
|
|
DEBUG = True
|
|
SQLACHEMY_ECHO = DEBUG
|
|
|
|
You can also set the `TESTING` flag to `True` so no mails are sent
|
|
(and no exception is raised) while you're on development mode.
|
|
Then before running the application, declare its path with ::
|
|
|
|
$ export IHATEMONEY_SETTINGS_FILE_PATH="$(pwd)/settings.cfg"
|
|
|
|
How to contribute
|
|
=================
|
|
|
|
You would like to contribute? First, thanks a bunch! This project is a small
|
|
project with just a few people behind it, so any help is appreciated!
|
|
|
|
There are different ways to help us, regarding if you are a designer,
|
|
a developer or an user.
|
|
|
|
As a developer
|
|
--------------
|
|
|
|
If you want to contribute code, you can write it and then issue a pull request on
|
|
github. Please, think about updating and running the tests before asking for
|
|
a pull request as it will help us to maintain the code clean and running.
|
|
|
|
To do so::
|
|
|
|
$ make test
|
|
|
|
As a designer / Front-end developer
|
|
-----------------------------------
|
|
|
|
Feel free to provide us mockups or to involve yourself into the discussions
|
|
hapenning on the github issue tracker. All ideas are welcome. Of course, if you
|
|
know how to implement them, feel free to fork and make a pull request.
|
|
|
|
As a translator
|
|
---------------
|
|
|
|
Collect all new strings to translate::
|
|
|
|
$ make update-translations
|
|
|
|
Add missing translations to *.po* files inside *translations/* dir using your
|
|
favorite text editor.
|
|
|
|
Compile them into *.mo* files::
|
|
|
|
$ make compile-translations
|
|
|
|
Commit both *.mo* and *.po*.
|
|
|
|
End-user
|
|
--------
|
|
|
|
You are using the application and found a bug? You have some ideas about how to
|
|
improve the project? Please tell us `by filling a new issue <https://github.com/spiral-project/ihatemoney/issues>`_.
|
|
Or, if you prefer, you can send me an email to `alexis@notmyidea.org` and I will
|
|
update the issue tracker with your feedback.
|
|
|
|
Thanks again!
|
|
|
|
How to build the documentation ?
|
|
=====================================
|
|
|
|
The documentation is using `sphinx <http://www.sphinx-doc.org/en/stable/>`_ and
|
|
its source is located inside the `docs folder
|
|
<https://github.com/spiral-project/ihatemoney/tree/master/docs>`_.
|
|
|
|
Install doc dependencies (within the virtualenv, if any)::
|
|
|
|
pip install -r docs/requirements.txt
|
|
|
|
And to produce html doc in `docs/_output` folder::
|
|
|
|
cd docs/
|
|
make html
|
|
|
|
How to release?
|
|
===============
|
|
|
|
In order to prepare a new release, we are following the following steps:
|
|
|
|
- Merge remaining pull requests;
|
|
- Update :file:`CHANGELOG.rst` with the last changes;
|
|
- Update :file:`CONTRIBUTORS`;
|
|
- Update known good versions of dependencies in ``requirements.txt`` with this command (from inside the venv):
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip freeze | grep -v -- '-e' > requirements.txt
|
|
|
|
Once this is done, use the "release" instruction:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ make release
|
|
|
|
And the new version should be published on PyPI.
|