.. _contributing:

=========================

Contributing to Kallithea

=========================

Kallithea is developed and maintained by its users. Please join us and scratch

your own itch.

Infrastructure

--------------

The main repository is hosted at Our Own Kallithea (aka OOK) on

https://kallithea-scm.org/repos/kallithea/ (which is our self-hosted instance

of Kallithea).

For now, we use Bitbucket_ for `Pull Requests`_ and `Issue Tracker`_ services. The

issue tracker is for tracking bugs, not for support, discussion, or ideas -

please use the `mailing list`_ to reach the community.

We use Weblate_ to translate the user interface messages into languages other

than English. Join our project on `Hosted Weblate`_ to help us.

To register, you can use your Bitbucket or GitHub account. See :ref:`translations`

for more details.

Getting started

---------------

To get started with development::

        hg clone https://kallithea-scm.org/repos/kallithea

        cd kallithea

        virtualenv ../kallithea-venv

        source ../kallithea-venv/bin/activate

        python setup.py develop

        paster make-config Kallithea my.ini

        paster setup-db my.ini --user=user --email=user@example.com --password=password --repos=/tmp

        paster serve my.ini --reload &

        firefox http://127.0.0.1:5000/

You can also start out by forking https://bitbucket.org/conservancy/kallithea

on Bitbucket_ and create a local clone of your own fork.

Running tests

-------------

After finishing your changes make sure all tests pass cleanly. You can run

the testsuite running ``nosetests`` from the project root, or if you use tox

run ``tox`` for python2.6-2.7 with multiple database test.

When using `nosetests`, the `test.ini` file is used with an SQLite database. Edit

this file to change your testing enviroment.

It is possible to avoid recreating the full test database on each invocation of

the tests, thus eliminating the initial delay. To achieve this, run the tests as::

    paster serve test.ini --pid-file=test.pid --daemon

    KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 nosetests

    kill -9 $(cat test.pid)

You can run individual tests by specifying their path as argument to nosetests.

nosetests also has many more options, see `nosetests -h`. Some useful options

are::

    -x, --stop            Stop running tests after the first error or failure

    -s, --nocapture       Don't capture stdout (any stdout output will be

                          printed immediately) [NOSE_NOCAPTURE]

    --failed              Run the tests that failed in the last test run.

Coding/contribution guidelines

------------------------------

Kallithea is GPLv3 and we assume all contributions are made by the

committer/contributor and under GPLv3 unless explicitly stated. We do care a

lot about preservation of copyright and license information for existing code

that is brought into the project.

We don't have a formal coding/formatting standard. We are currently using a mix

of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and

consistency with existing code. Run whitespacecleanup.sh to avoid stupid

whitespace noise in your patches.

We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care

about Python 3 compatibility.

We primarily support Linux and OS X on the server side but Windows should also work.

Html templates should use 2 spaces for indentation ... but be pragmatic. We

should use templates cleverly and avoid duplication. We should use reasonable

semantic markup with classes and ids that can be used for styling and testing.

We should only use inline styles in places where it really is semantic (such as

display:none).

JavaScript must use ';' between/after statements. Indentation 4 spaces. Inline

multiline functions should be indented two levels - one for the () and one for

{}. jQuery value arrays should have a leading $.

Commit messages should have a leading short line summarizing the changes. For

bug fixes, put "(Issue #123)" at the end of this line.

Contributions will be accepted in most formats - such as pull requests on

bitbucket, something hosted on your own Kallithea instance, or patches sent by

mail to the kallithea-general mailing list.

Make sure to test your changes both manually and with the automatic tests

before posting.

We care about quality and review and keeping a clean repository history. We

might give feedback that requests polishing contributions until they are

"perfect". We might also rebase and collapse and make minor adjustments to your

changes when we apply them.

We try to make sure we have consensus on the direction the project is taking.

Everything non-sensitive should be discussed in public - preferably on the

mailing list.  We aim at having all non-trivial changes reviewed by at least

one other core developer before pushing. Obvious non-controversial changes will

be handled more casually.

For now we just have one official branch ("default") and will keep it so stable

that it can be (and is) used in production. Experimental changes should live

elsewhere (for example in a pull request) until they are ready.

.. _translations:

.. include:: ./../kallithea/i18n/how_to

"Roadmap"

---------

We do not have a road map but are waiting for your contributions. Refer to the

wiki_ for some ideas of places we might want to go - contributions in these

areas are very welcome.

Thank you for your contribution!

--------------------------------

.. _Weblate: http://weblate.org/

.. _Issue Tracker: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open

.. _Pull Requests: https://bitbucket.org/conservancy/kallithea/pull-requests

.. _bitbucket: http://bitbucket.org/

.. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general

.. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/

.. _wiki: https://bitbucket.org/conservancy/kallithea/wiki/Home

## -*- coding: utf-8 -*-

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">

    <head>

        <title><%block name="title"/><%block name="branding_title"/></title>

        <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />

        <meta name="robots" content="index, nofollow"/>

        <link rel="icon" href="${h.url('/images/favicon.ico')}" type="image/png" />

        ## CSS ###

        <link rel="stylesheet" type="text/css" href="${h.url('/js/select2/select2.css', ver=c.kallithea_version)}"/>

        <link rel="stylesheet" type="text/css" href="${h.url('/css/pygments.css', ver=c.kallithea_version)}"/>

        <link rel="stylesheet" type="text/css" href="${h.url('/css/style.css', ver=c.kallithea_version)}" media="screen"/>

        <link rel="stylesheet" type="text/css" href="${h.url('/css/contextbar.css', ver=c.kallithea_version)}" media="screen"/>

        <link rel="stylesheet" type="text/css" href="${h.url('/fontello/css/kallithea.css', ver=c.kallithea_version)}">

        <%block name="css_extra"/>

        ## JAVASCRIPT ##

        <script type="text/javascript">

            ## JS translations map

            var TRANSLATION_MAP = {

                'Add Another Comment':'${_("Add Another Comment")}',

                'Stop following this repository':"${_('Stop following this repository')}",

                'Start following this repository':"${_('Start following this repository')}",

                'Group':"${_('Group')}",

                'members':"${_('members')}",

                'Loading ...':"${_('Loading ...')}",

                'loading ...':"${_('loading ...')}",

                'Search truncated': "${_('Search truncated')}",

                'No matching files': "${_('No matching files')}",

                'Open New Pull Request': "${_('Open New Pull Request')}",

                'Open New Pull Request for Selected Changesets':  "${_('Open New Pull Request for Selected Changesets')}",

                'Show Selected Changesets __S → __E': "${h.literal(_('Show Selected Changesets __S → __E'))}",

                'Show Selected Changeset __S': "${_('Show Selected Changeset __S')}",

                'Selection Link': "${_('Selection Link')}",

                'Collapse Diff': "${_('Collapse Diff')}",

                'Expand Diff': "${_('Expand Diff')}",

                'Failed to revoke permission': "${_('Failed to revoke permission')}",

                'Confirm to revoke permission for {0}: {1} ?': "${_('Confirm to revoke permission for {0}: {1} ?')}",

                'enabled': "${_('enabled')}",

                'disabled': "${_('disabled')}",

                'Select changeset': "${_('Select changeset')}",

                'Specify changeset': "${_('Specify changeset')}",

                'MSG_SORTASC': "${_('Click to sort ascending')}",

                'MSG_SORTDESC': "${_('Click to sort descending')}",

                'MSG_EMPTY': "${_('No records found.')}",

                'MSG_ERROR': "${_('Data error.')}",

                'MSG_LOADING': "${_('Loading...')}"

            };

            var _TM = TRANSLATION_MAP;

            var TOGGLE_FOLLOW_URL  = "${h.url('toggle_following')}";

            var REPO_NAME = "";

            %if hasattr(c, 'repo_name'):

                var REPO_NAME = "${c.repo_name}";

            %endif

            var _authentication_token = "${h.authentication_token()}";

        </script>

        <script type="text/javascript" src="${h.url('/js/yui.2.9.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/jquery-1.11.1.min.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/bootstrap.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/select2/select2.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/mousetrap.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/yui.flot.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/native.history.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/pyroutes_map.js', ver=c.kallithea_version)}"></script>

        <script type="text/javascript" src="${h.url('/js/base.js', ver=c.kallithea_version)}"></script>

        ## EXTRA FOR JS

        <%block name="js_extra"/>

        <script type="text/javascript">

            (function(window,undefined){

                var History = window.History; // Note: We are using a capital H instead of a lower h

                if ( !History.enabled ) {

                     // History.js is disabled for this browser.

                     // This is because we can optionally choose to support HTML4 browsers or not.

                    return false;

                }

            })(window);

            $(document).ready(function(){

              tooltip_activate();

              show_more_event();

              show_changeset_tooltip();

              // routes registration

              pyroutes.register('home', "${h.url('home')}", []);

              pyroutes.register('new_gist', "${h.url('new_gist')}", []);

              pyroutes.register('gists', "${h.url('gists')}", []);

              pyroutes.register('new_repo', "${h.url('new_repo')}", []);

              pyroutes.register('summary_home', "${h.url('summary_home', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('changelog_home', "${h.url('changelog_home', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('files_home', "${h.url('files_home', repo_name='%(repo_name)s',revision='%(revision)s',f_path='%(f_path)s')}", ['repo_name', 'revision', 'f_path']);

              pyroutes.register('edit_repo', "${h.url('edit_repo', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('edit_repo_perms', "${h.url('edit_repo_perms', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('pullrequest_home', "${h.url('pullrequest_home', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('toggle_following', "${h.url('toggle_following')}");

              pyroutes.register('changeset_info', "${h.url('changeset_info', repo_name='%(repo_name)s', revision='%(revision)s')}", ['repo_name', 'revision']);

              pyroutes.register('repo_size', "${h.url('repo_size', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('changeset_comment_preview', "${h.url('changeset_comment_preview', repo_name='%(repo_name)s')}", ['repo_name']);

              pyroutes.register('repo_refs_data', "${h.url('repo_refs_data', repo_name='%(repo_name)s')}", ['repo_name']);

             });

        </script>

        <%block name="head_extra"/>

    </head>

    <body id="body">

      ## IE hacks

      <!--[if IE 7]>

      <script>$(document.body).addClass('ie7')</script>

      <![endif]-->

      <!--[if IE 8]>

      <script>$(document.body).addClass('ie8')</script>

      <![endif]-->

      <!--[if IE 9]>

      <script>$(document.body).addClass('ie9')</script>

      <![endif]-->

      <div id="header">

        <div id="header-inner" class="title">

          <div id="logo">

            <a href="${h.url('home')}" style="display: block;">

              <div class="header">

                <img src="${h.url('/images/kallithea-logo.svg')}" onerror="this.onerror='';this.src='${h.url('/images/kallithea-logo.png')}'" alt="Kallithea"/>

              </div>

              %if c.site_name:

                <div class="branding">${c.site_name}</div>

              %endif

            </a>

          </div>

          <%block name="header_menu"/>

        </div>

      </div>

      ${next.body()}

      %if c.ga_code:

      ${h.literal(c.ga_code)}

      %endif

    </body>

</html>