Mercurial > kallithea

comparison docs/contributing.rst @ 5971:a5a16aad6b3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: run-all-cleanup superseded whitespaceleanup.sh
author Konstantin Veretennicov <kveretennicov@gmail.com>
date Wed, 15 Jun 2016 21:12:39 +0200
parents 5262c498b3a0
children 653fee8db519
comparison
equal deleted inserted replaced
5970:10d7b01af4f0 5971:a5a16aad6b3e
98 lot about preservation of copyright and license information for existing code 98 lot about preservation of copyright and license information for existing code
99 that is brought into the project. 99 that is brought into the project.
100 100
101 We don't have a formal coding/formatting standard. We are currently using a mix 101 We don't have a formal coding/formatting standard. We are currently using a mix
102 of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and 102 of Mercurial (http://mercurial.selenic.com/wiki/CodingStyle), pep8, and
103 consistency with existing code. Run whitespacecleanup.sh to avoid stupid 103 consistency with existing code. Run ``scripts/run-all-cleanup`` before
104 whitespace noise in your patches. 104 committing to ensure some basic code formatting consistency.
105 105
106 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care 106 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care
107 about Python 3 compatibility. 107 about Python 3 compatibility.
108 108
109 We try to support the most common modern web browsers. IE9 is still supported 109 We try to support the most common modern web browsers. IE9 is still supported
119 119
120 JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline 120 JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline
121 multiline functions should be indented two levels -- one for the ``()`` and one for 121 multiline functions should be indented two levels -- one for the ``()`` and one for
122 ``{}``. 122 ``{}``.
123 Variables holding jQuery objects should be named with a leading ``$``. 123 Variables holding jQuery objects should be named with a leading ``$``.
124
125 Run ``scripts/run-all-cleanup`` before committing to ensure some basic code
126 formatting consistency.
127 124
128 Commit messages should have a leading short line summarizing the changes. For 125 Commit messages should have a leading short line summarizing the changes. For
129 bug fixes, put ``(Issue #123)`` at the end of this line. 126 bug fixes, put ``(Issue #123)`` at the end of this line.
130 127
131 Use American English grammar and spelling overall. Use `English title case`_ for 128 Use American English grammar and spelling overall. Use `English title case`_ for