Mercurial > kallithea
changeset 3993:b53cef6faf22
updated contributing docs
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Wed, 12 Jun 2013 20:38:05 +0200 |
parents | c1a1f05e680f |
children | 1f71ef689d2a |
files | docs/contributing.rst |
diffstat | 1 files changed, 20 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/contributing.rst Wed Jun 12 20:02:01 2013 +0200 +++ b/docs/contributing.rst Wed Jun 12 20:38:05 2013 +0200 @@ -10,13 +10,15 @@ 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 **BETA** branch since your -fix might be already fixed there and i try to merge all fixes from beta into -stable, and not the other way. Finally, when you are finished making a change, +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 from `requires.txt` file. +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:: @@ -25,10 +27,23 @@ 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. +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