Changeset - f0b9706d8d7e
[Not reviewed]
default
0 1 1
Mads Kiilerich - 10 years ago 2016-05-02 23:45:26
madski@unity3d.com
scripts: introduce scripts/run-all-cleanup - run this before committing to make sure some aspects of the coding style is maintained
2 files changed with 13 insertions and 0 deletions:
0 comments (0 inline, 0 general)
docs/contributing.rst
Show inline comments
 
@@ -109,24 +109,27 @@ We primarily support Linux and OS X on t
 

	
 
HTML templates should use 2 spaces for indentation ... but be pragmatic. We
 
should use templates cleverly and avoid duplication. We should use reasonable
 
semantic markup with element classes and IDs that can be used for styling and testing.
 
We should only use inline styles in places where it really is semantic (such as
 
``display: none``).
 

	
 
JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline
 
multiline functions should be indented two levels -- one for the ``()`` and one for
 
``{}``.
 
Variables holding jQuery objects should be named with a leading ``$``.
 

	
 
Run ``scripts/run-all-cleanup`` before committing to ensure some basic code
 
formatting consistency.
 

	
 
Commit messages should have a leading short line summarizing the changes. For
 
bug fixes, put ``(Issue #123)`` at the end of this line.
 

	
 
Use American English grammar and spelling overall. Use `English title case`_ for
 
page titles, button labels, headers, and 'labels' for fields in forms.
 

	
 
.. _English title case: https://en.wikipedia.org/wiki/Capitalization#Title_case
 

	
 
Contributions will be accepted in most formats -- such as pull requests on
 
bitbucket, something hosted on your own Kallithea instance, or patches sent by
 
email to the `kallithea-general`_ mailing list.
 

	
scripts/run-all-cleanup
Show inline comments
 
new file 100755
 
#!/usr/bin/sh
 

	
 
# Convenience script for running various idempotent source code cleanup scripts
 

	
 
set -e
 
set -x
 

	
 
scripts/docs-headings.py
 
scripts/generate-ini.py
 
scripts/whitespacecleanup.sh
0 comments (0 inline, 0 general)