federation/docs/development.rst

41 wiersze
907 B
ReStructuredText

Development
===========
Help is more than welcome to extend this library. Please see the following resources.
* `Source code repo <https://git.feneas.org/jaywink/federation>`_
* `Issue tracker <https://git.feneas.org/jaywink/federation/issues>`_
* `Kanban board <https://git.feneas.org/jaywink/federation/boards>`_
Environment setup
-----------------
Once you have your (Python 3.6+) virtualenv set up, install the development requirements::
pip install -r dev-requirements.txt
Running tests
-------------
::
py.test
Building local documentation
----------------------------
::
cd docs
make html
Built documentation is available at ``docs/_build/html/index.html``.
Contact for help
----------------
Easiest via Matrix on room ``#socialhome:feneas.org``. There is a bridged
Freenode channel as well found at ``#socialhome``.
You can also ask questions or give feedback via issues.