Miroir du site de l'AE UTBM https://ae.utbm.fr
Go to file
Antoine Bartuccio c73f4ca847
documentation: add CONTRIBUTING
2019-10-08 11:08:47 +02:00
accounting small fix to follow python recommendations 2019-02-02 00:32:34 +01:00
api All: Apply Black coding rules 2018-10-05 21:52:55 +02:00
club club: fix SellingFormBase import 2019-05-21 10:53:18 +02:00
com documentation: weekmail documentation 2019-10-07 23:58:04 +02:00
core core: wrap compilemessages to avoid compiling whole env and avoid crash at sphinx messages compilation 2019-10-08 00:59:00 +02:00
counter Merge branch 'counter' into 'master' 2019-09-20 14:03:07 +02:00
doc documentation: apply corrections suggested in comments 2019-10-08 11:08:33 +02:00
eboutic eboutic: add some help and documentation for the payment system 2019-05-27 11:20:57 +02:00
election elections: use MarkdownInput for CandidateForm 2018-12-20 16:43:59 +01:00
forum forum: enhance performances on toggle_favorite 2019-09-15 16:12:24 +02:00
launderette All: Apply Black coding rules 2018-10-05 21:52:55 +02:00
locale/fr/LC_MESSAGES core: fix error 500 with expired reset password links 2019-09-10 16:56:58 +02:00
matmat All: Apply Black coding rules 2018-10-05 21:52:55 +02:00
pedagogy pedagogy: add script to remove all previous doubled comments 2019-09-04 20:49:18 +02:00
rootplace rootplace: make code clearer and fix typos 2019-03-19 17:23:02 +01:00
sas sas: add cache on Picture permissions to avoid hitting the bdd too much 2019-09-16 11:33:32 +02:00
sith documentation: base structure for new documentation 2019-10-07 23:51:35 +02:00
stock All: Apply Black coding rules 2018-10-05 21:52:55 +02:00
subscription SUBSCRIPTIONS: 5 new discounted subscriptions for integration 2019-08-29 19:06:58 +02:00
trombi trombi: permissions fixs 2019-10-02 14:56:04 +02:00
.coveragerc coverage: blacklist some files 2017-09-07 11:50:05 +02:00
.envrc documentation: add instructions for direnv 2019-10-08 00:59:19 +02:00
.gitattributes Add mappings for .po and .jinja files 2019-04-22 18:20:22 +02:00
.gitignore documentation: base structure for new documentation 2019-10-07 23:51:35 +02:00
.gitlab-ci.yml documentation: add doc compile test in pipeline 2019-10-07 23:51:38 +02:00
.readthedocs.yml documentation: base structure for new documentation 2019-10-07 23:51:35 +02:00
CONTRIBUTING.rst documentation: add CONTRIBUTING 2019-10-08 11:08:47 +02:00
LICENSE Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
LICENSE.old Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
README.rst documentation: rewrite README and remove TODO 2019-10-07 23:51:38 +02:00
manage.py Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
migrate.py pedagogy: fix typo for AUTUMN_AND_SPRING 2019-07-05 16:40:02 +02:00
requirements.txt documentation: installation instructions 2019-10-07 23:51:36 +02:00

README.rst

.. image:: https://ae-dev.utbm.fr/ae/Sith/badges/master/pipeline.svg
  :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
  :alt: pipeline status

.. image:: https://readthedocs.org/projects/sith-ae/badge/?version=latest
  :target: https://sith-ae.readthedocs.io/?badge=latest
  :alt: documentation Status

.. image:: https://ae-dev.utbm.fr/ae/Sith/badges/master/coverage.svg
  :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
  :alt: coverage report

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :target: https://github.com/ambv/black
  :alt: code style: black

.. image:: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
  :target: https://ae-dev.zulipchat.com
  :alt: project chat

This is the source code of the UTBM's student association available at https://ae.utbm.fr/.

All documentation is in the ``docs`` directory and online at https://sith-ae.readthedocs.io/. This documentation is written in French because it targets a French audience and it's too much work to maintain two versions. The code and code comments are strictly written in English.

If you want to contribute, here's how we recommend to read the docs:

* First, it's advised to read the about part of the project to understand the goals and the mindset of the current and previous maintainers and know what to expect to learn.
* If in the first part you find you need more background about what we use, we provide some links to tutorials and documentation at the end of our documentation. Feel free to use it and complete it with what you found helpful.
* Keep in mind that this documentation is thought to be read in order.

To join our team :

* Send a mail at mailto:ae.utbm.fr
* Join our group chat at https://ae-dev.zulipchat.com
* See and join our Trello at https://trello.com/b/YQOaF33m/site-ae.

This project is licenced under GNU GPL, see the LICENSE file at the top of the repository for more details.