Mercurial > kallithea
annotate docs/contributing.rst @ 4907:6d64335f380a
i18n: updated Japanese translation using Weblate
Currently translated at 99.8% (1075 of 1077 strings)
author | kobanari <kobanari@nifty.com> |
---|---|
date | Fri, 30 Jan 2015 15:18:43 +0000 |
parents | 03bbd33bc084 |
children | 95fe05b1e5f8 |
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 | |
4902 | 7 Kallithea is developed and maintained by its users. Please join us and scratch |
8 your own itch. | |
9 | |
10 | |
11 Infrastructure | |
12 -------------- | |
811 | 13 |
4902 | 14 The main repository is hosted at Our Own Kallithea (aka OOK) on |
15 https://kallithea-scm.org/repos/kallithea/ (which is our self-hosted instance | |
16 of Kallithea). | |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
811
diff
changeset
|
17 |
4902 | 18 For now, we use Bitbucket_ for `Pull Requests`_ and `Issue Tracker`_ services. The |
19 issue tracker is for tracking bugs, not for "support", discussion or ideas - | |
20 please use the `mailing list`_ to reach the community. | |
21 | |
22 We use Weblate_ to translate the user interface messages into languages other | |
23 than English. Join our project on `Hosted Weblate`_ to help us. | |
24 To register, you can use your Bitbucket or GitHub account. | |
25 | |
3993
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
26 |
4902 | 27 Getting started |
28 --------------- | |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
811
diff
changeset
|
29 |
4902 | 30 To get started with development:: |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
31 |
4902 | 32 hg clone https://kallithea-scm.org/repos/kallithea |
33 cd kallithea | |
34 virtualenv ../kallithea-venv | |
35 source ../kallithea-venv/bin/activate | |
36 python setup.py develop | |
37 paster make-config Kallithea my.ini | |
38 paster setup-db my.ini --user=user --email=user@example.com --password=password --repos=/tmp | |
39 paster serve my.ini --reload & | |
40 firefox http://127.0.0.1:5000/ | |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
41 |
4902 | 42 You can also start out by forking https://bitbucket.org/conservancy/kallithea |
43 on Bitbucket_ and create a local clone of your own fork. | |
44 | |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
45 |
4902 | 46 Running tests |
47 ------------- | |
48 | |
49 After finishing your changes make sure all tests pass cleanly. You can run | |
2600
1b9d6b0a92b3
updated contributing with tox info
Marcin Kuzminski <marcin@python-works.com>
parents:
2504
diff
changeset
|
50 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
|
51 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
|
52 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
|
53 to change your testing enviroment. |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
54 |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
55 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
|
56 |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
57 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
|
58 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
|
59 kill -9 $(cat test.pid) |
b53cef6faf22
updated contributing docs
Marcin Kuzminski <marcin@python-works.com>
parents:
3700
diff
changeset
|
60 |
2032
950110f3f99f
merged changes from stable into beta
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
61 |
4902 | 62 Coding/contribution guidelines |
63 ------------------------------ | |
64 | |
65 Kallithea is GPLv3 and we assume all contributions are made by the | |
66 committer/contributor and under GPLv3 unless explicitly stated. We do care a | |
67 lot about preservation of copyright and license information for existing code | |
68 that is brought into the project. | |
69 | |
70 We don't have a formal coding/formatting standard. We are currently using a mix | |
71 of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and | |
72 consistency with existing code. Run whitespacecleanup.sh to avoid stupid | |
73 whitespace noise in your patches. | |
74 | |
75 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care | |
76 about Python 3 compatibility. | |
77 | |
78 We try to support the most common modern web browsers. IE8 is still supported | |
79 to the extent it is feasible but we may stop supporting it very soon. | |
80 | |
81 We primarily support Linux and OS X on the server side but Windows should also work. | |
82 | |
83 Html templates should use 2 spaces for indentation ... but be pragmatic. We | |
84 should use templates cleverly and avoid duplication. We should use reasonable | |
85 semantic markup with classes and ids that can be used for styling and testing. | |
86 We should only use inline styles in places where it really is semantic (such as | |
87 display:none). | |
88 | |
89 JavaScript must use ';' between/after statements. Indentation 4 spaces. Inline | |
90 multiline functions should be indented two levels - one for the () and one for | |
91 {}. jQuery value arrays should have a leading $. | |
92 | |
93 Commit messages should have a leading short line summarizing the changes. For | |
94 bug fixes, put "(Issue #123)" at the end of this line. | |
95 | |
96 Contributions will be accepted in most formats - such as pull requests on | |
97 bitbucket, something hosted on your own Kallithea instance, or patches sent by | |
98 mail to the kallithea-general mailing list. | |
99 | |
100 Make sure to test your changes both manually and with the automatic tests | |
101 before posting. | |
102 | |
103 We care about quality and review and keeping a clean repository history. We | |
104 might give feedback that requests polishing contributions until they are | |
105 "perfect". We might also rebase and collapse and make minor adjustments to your | |
106 changes when we apply them. | |
107 | |
108 We try to make sure we have consensus on the direction the project is taking. | |
109 Everything non-sensitive should be discussed in public - preferably on the | |
110 mailing list. We aim at having all non-trivial changes reviewed by at least | |
111 one other core developer before pushing. Obvious non-controversial changes will | |
112 be handled more casually. | |
113 | |
114 For now we just have one official branch ("default") and will keep it so stable | |
115 that it can be (and is) used in production. Experimental changes should live | |
116 elsewhere (for example in a pull request) until they are ready. | |
1123 | 117 |
118 | |
4902 | 119 "Roadmap" |
120 --------- | |
121 | |
122 We do not have a road map but are waiting for your contributions. Here are some | |
123 ideas of places we might want to go - contributions in these areas are very | |
124 welcome: | |
125 | |
126 * Front end: | |
127 * kill YUI - more jQuery | |
128 * remove other dependencies - especially the embedded cut'n'pasted ones | |
129 * remove hardcoded styling in templates, make markup more semantic while moving all styling to css | |
130 * switch to bootstrap or some other modern UI library and cleanup of style.css and contextbar.css | |
131 * new fancy style that looks good | |
132 * testing | |
133 * better test coverage with the existing high level test framework | |
134 * test even more high level and javascript - selenium/robot and splinter seems like the top candidates | |
135 * more unit testing | |
136 * code cleanup | |
137 * move code from templates to controllers and from controllers to libs or models | |
138 * more best practice for web apps and the frameworks | |
139 * features | |
140 * relax dependency version requirements after thorough testing | |
141 * support for evolve | |
142 * updates of PRs ... while preserving history and comment context | |
143 * auto pr merge/rebase | |
144 * ssh | |
145 * bitbucket compatible wiki | |
146 * realtime preview / wysiwyg when editing comments and files | |
147 * make journal more useful - filtering on branches and files | |
148 * community mode with self registration and personal space | |
149 * improve documentation | |
150 | |
151 Thank you for your contribution! | |
152 -------------------------------- | |
153 | |
154 | |
155 .. _Weblate: http://weblate.org/ | |
156 .. _Issue Tracker: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open | |
157 .. _Pull Requests: https://bitbucket.org/conservancy/kallithea/pull-requests | |
1123 | 158 .. _bitbucket: http://bitbucket.org/ |
4902 | 159 .. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general |
160 .. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/ |