Mercurial > kallithea
annotate docs/contributing.rst @ 4895:780c1aab1357
pullrequest overview: remove custom handling of 'my pullrequests'
Re-use the same displaying code for the 'my pullrequests' overview as for
the repository pullrequests overview. Remove the now unused CSS styling as
well.
This removes the 'delete' button on the author's pullrequests. One could
argue whether the pullrequest overview is the right place for this button,
while it does not appear on the pull request page itself.
author | Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> |
---|---|
date | Tue, 03 Mar 2015 21:48:53 +0100 |
parents | a9a1560dad79 |
children | 03bbd33bc084 |
rev | line source |
---|---|
811 | 1 .. _contributing: |
2 | |
2095 | 3 ========================= |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
4 Contributing to Kallithea |
811 | 5 ========================= |
6 | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
7 If you would like to contribute to Kallithea, please contact us, any help is |
1092
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 | 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 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
11 Kallithea repository on bitbucket_ |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3993
diff
changeset
|
12 https://bitbucket.org/conservancy/kallithea and then make your changes to |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
13 your forked repository. Please post all fixes into **dev** bookmark since your |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
14 change might be already fixed there and i try to merge all fixes from dev into |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
15 stable, and not the other way. Finally, when you are finished with your changes, |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
16 please send us a pull request. |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
811
diff
changeset
|
17 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
18 To run Kallithea in a development version you always need to install the latest |
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
19 required libs. Simply clone Kallithea and switch to beta branch:: |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
20 |
4179
010e9532801a
Change bitbucket and hosting URL
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
3993
diff
changeset
|
21 hg clone https://kallithea-scm.org/repos/kallithea |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
811
diff
changeset
|
22 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
23 after downloading/pulling Kallithea make sure you run:: |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
24 |
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
25 python setup.py develop |
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
26 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2600
diff
changeset
|
27 command to install/verify all required packages, and prepare development |
2094 | 28 enviroment. |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
29 |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
30 There are two files in the directory production.ini and developement.ini copy |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
31 the `development.ini` file as rc.ini (which is excluded from version controll) |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
32 and put all your changes like db connection or server port in there. |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
33 |
2094 | 34 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
|
35 the testsuite running ``nosetest`` from the project root, or if you use tox |
4522
a9a1560dad79
setup: clarify that we only support 2.6 and 2.7
Mads Kiilerich <madski@unity3d.com>
parents:
4206
diff
changeset
|
36 run tox for python2.6-2.7 with multiple database test. When using `nosetests` |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
37 test.ini file is used and by default it uses sqlite for tests, edit this file |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
38 to change your testing enviroment. |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
39 |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
40 |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
41 There's a special set of tests for push/pull operations, you can runn them using:: |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
42 |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
43 paster serve test.ini --pid-file=test.pid --daemon |
4206
703d3208424c
Rename various strings for tests
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4192
diff
changeset
|
44 KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 nosetests -x kallithea/tests/other/test_vcs_operations.py |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
45 kill -9 $(cat test.pid) |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
46 |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
47 |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1062
diff
changeset
|
48 | Thank you for any contributions! |
1123 | 49 |
50 | |
51 .. _bitbucket: http://bitbucket.org/ |