view website/www/code.txt @ 7658:d30e534b078a

clarify doc on dispatcher_email config setting. An issue was brought up on the mailing list. https://sourceforge.net/p/roundup/mailman/message/43383465/ The description of dispatcher_email sounds like it should be sent email on issue creation. That's not it's role. Try to make it's role more obvious. Fix config.ini and reference.txt description. Add the newissuecopy.py detector to send email on the creation of an issue
author John Rouillard <rouilj@ieee.org>
date Tue, 10 Oct 2023 20:33:22 -0400
parents 6f5054751fb6
children 141225d2981e
line wrap: on
line source

.. meta::
    :description:
        Information for developers of Roundup. Including directions on
        checking code from repository, how to run demo mode and
        execute tests.

Code
====

Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_
file in code repository of Roundup, which can also be viewed online
through SourceForge `web interface <https://sourceforge.net/p/roundup/code/ci/default/tree/>`_.

Get sources
-----------

Official **read-only access** to Mercurial repository is provided through ::

  hg clone http://hg.code.sf.net/p/roundup/code roundup

**Read/write access** requires SSH password or SSH key
authorization (see `SourceForge.net docs for details
<https://sourceforge.net/p/forge/documentation/Mercurial/>`_) ::

  hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup

You also need to be added as a Roundup developer for write access - ask
for it on the :doc:`roundup-devel list <contact>`.

Run demo
--------

Roundup doesn't need any dependencies and works out of the box. Demo
is accessible at http://localhost:8917/demo/ by default ::

  cd roundup
  python demo.py

Execute tests
-------------
::

  python -m pytest test

See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_
for more info.

Roundup Issue Tracker: http://roundup-tracker.org/