Mercurial > kallithea

annotate docs/contributing.rst @ 3181:efe23d6c178c rhodecode-0.0.1.5.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merged with beta
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 21 Jan 2013 00:49:59 +0100
parents 63e58ef80ef1
children 3563bb7b4b82
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _contributing:
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
2095
Marcin Kuzminski <marcin@python-works.com>
parents: 2094
diff changeset
3 =========================
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
4 Contributing to RhodeCode
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 =========================
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
7 If you would like to contribute to RhodeCode, please contact me, any help is
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
8 greatly appreciated!
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
10 Could I request that you make your source contributions by first forking the
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
11 RhodeCode repository on bitbucket_
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
12 https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
13 your forked repository. Please post all fixes into **BETA** branch since your
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
14 fix might be already fixed there and i try to merge all fixes from beta into
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
15 stable, and not the other way. Finally, when you are finished making a change,
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
16 please send me a pull request.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
17
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
18 To run RhodeCode in a development version you always need to install the latest
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
19 required libs from `requires.txt` file.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
20
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
21 after downloading/pulling RhodeCode make sure you run::
2032
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
22
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
23 python setup.py develop
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
24
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
25 command to install/verify all required packages, and prepare development
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
26 enviroment.
2032
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
27
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
28
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
29 After finishing your changes make sure all tests passes ok. You can run
2600
1b9d6b0a92b3 updated contributing with tox info
Marcin Kuzminski <marcin@python-works.com>
parents: 2504
diff changeset
30 the testsuite running ``nosetest`` from the project root, or if you use tox
1b9d6b0a92b3 updated contributing with tox info
Marcin Kuzminski <marcin@python-works.com>
parents: 2504
diff changeset
31 run tox for python2.5-2.7 with multiple database test.
2032
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
32
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
33 | Thank you for any contributions!
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
34 | Marcin
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
35
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
36
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
37
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
38 .. _bitbucket: http://bitbucket.org/