Mercurial > kallithea

annotate docs/contributing.rst @ 2094:6fdc3b25bc7c beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 02 Mar 2012 22:07:07 +0200
parents 950110f3f99f
children 17c9393e9645
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
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
3 Contributing to RhodeCode
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 =========================
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
6 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
7 greatly appreciated!
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
8
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
9 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
10 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
11 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
12 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
13 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
14 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
15 please send me a pull request.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
16
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
17 To run RhodeCode in a development version you always need to install the latest
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
18 required libs from `requires.txt` file.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
19
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
20 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
21
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
22 python setup.py develop
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
23
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
24 command to install/verify all required packages, and prepare development
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
25 enviroment.
2032
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
26
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
27
2094
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
28 After finishing your changes make sure all tests passes ok. You can run
Marcin Kuzminski <marcin@python-works.com>
parents: 2032
diff changeset
29 the testsuite running nosetest from the project root.
2032
950110f3f99f merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
30
1092
8af52e1224ff merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
31 | 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
32 | Marcin
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
33
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1092
diff changeset
34
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 .. _bitbucket: http://bitbucket.org/