Files @ aa3b55946089
Branch filter:

Location: kallithea/docs/contributing.rst - annotation

aa3b55946089 1.9 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
"Bradley M. Kuhn"
Migrate to Mergely 3.3.4.

RhodeCode 2.2.5 distributed Mergely 3.3.4 with some of the changes that
Mergely 3.3.3 in RhodeCode 1.7.2 also had. That do however not seem to be
changes we want for Kallithea this way and we take the 3.3.4 files as they are.

I've also included the Mergely license file, as downloaded from:
http://www.mergely.com/license.php

That LICENSE file is kept in HTML just as it was downloaded from their
website. While it's a bit annoying to keep the license file in HTML, this is
the way it came from upstream so we'll leave it that way.

Since the Javascript code is used with other GPLv3 Javascript, we are using the
GPL option of Mergely's tri-license.

Finally, note that previously, this was incorrectly called "mergerly", so the
opportunity is taken here to correct the name. That required changes to
diff_2way.html.

As commands::

$ wget -N --output-document LICENSE-MERGELY.html http://www.mergely.com/license.php
$ hg add LICENSE-MERGELY.html
$ hg mv rhodecode/public/css/mergerly.css rhodecode/public/css/mergely.css
$ hg mv rhodecode/public/js/mergerly.js rhodecode/public/js/mergely.js
$ sed -i 's,mergerly\.,mergely,g' rhodecode/templates/files/diff_2way.html
$ ( cd /tmp; \
wget -N http://www.mergely.com/releases/mergely-3.3.4.zip; \
unzip mergely-3.3.4.zip )
$ sha256sum /tmp/mergely-3.3.4.zip
87415d30494bbe829c248881aa7cdc0303f7e70b458a5f687615564d4498cc82 mergely-3.3.4.zip
$ cp /tmp/mergely-3.3.4/lib/mergely.js rhodecode/public/js/mergely.js
$ cp /tmp/mergely-3.3.4/lib/mergely.css rhodecode/public/css/mergely.css
$ sed -i -e '/^ \* Version/a\ *\n * NOTE by bkuhn@sfconservancy.org for Kallithea:\n * Mergely license appears at http://www.mergely.com/license.php and in LICENSE-MERGELY.html' rhodecode/public/js/mergely.js rhodecode/public/css/mergely.css
.. _contributing:

=========================
Contributing to RhodeCode
=========================

If you would like to contribute to RhodeCode, please contact me, any help is
greatly appreciated!

Could I request that you make your source contributions by first forking the
RhodeCode repository on bitbucket_
https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to
your forked repository. Please post all fixes into **dev** bookmark since your
change might be already fixed there and i try to merge all fixes from dev into
stable, and not the other way. Finally, when you are finished with your changes,
please send me a pull request.

To run RhodeCode in a development version you always need to install the latest
required libs. Simply clone rhodecode and switch to beta branch::

    hg clone -u dev https://secure.rhodecode.org/rhodecode

after downloading/pulling RhodeCode make sure you run::

    python setup.py develop

command to install/verify all required packages, and prepare development
enviroment.

There are two files in the directory production.ini and developement.ini copy
the `development.ini` file as rc.ini (which is excluded from version controll)
and put all your changes like db connection or server port in there.

After finishing your changes make sure all tests passes ok. You can run
the testsuite running ``nosetest`` from the project root, or if you use tox
run tox for python2.5-2.7 with multiple database test. When using `nosetests`
test.ini file is used and by default it uses sqlite for tests, edit this file
to change your testing enviroment.


There's a special set of tests for push/pull operations, you can runn them using::

    paster serve test.ini --pid-file=test.pid --daemon
    RC_WHOOSH_TEST_DISABLE=1 RC_NO_TMP_PATH=1 nosetests -x rhodecode/tests/other/test_vcs_operations.py
    kill -9 $(cat test.pid)


| Thank you for any contributions!
|  Marcin



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