diff --git a/doc/contributing.rst b/doc/contributing.rst index d96f84fcf7bd0ac294d7d21d62f5e62f94ae9643..16777995889be1ef15ace977e1f43b2b3da3f940 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -252,6 +252,17 @@ from it. As an example, your feature will go by the name of 'sidechains'. This time, |git| should tell you about going for **a new** branch. +Before starting to create anything for real, now is the perfect moment to +install our very own |git| hook to check some coding rules on commit. + +.. code-block:: console + + $ cp extras/pre-commit .git/hooks/ + $ + +With that in place, changes which break our coding standards will abort any +commit. + Now create the directory structure where your project will live. Here is the list of directories which are likely to be used in every project. @@ -600,5 +611,6 @@ contributions to web pages using |project|. .. LocalWords: mkdir linenos subdirectory abrv emphasize CXX GNUCXX gcc fno .. LocalWords: ARGS endif OPTIMIZE LIBEXEC Wno DIRS dirs subdirs config dbg .. LocalWords: changelog Optimized DOPTIMIZE gitignore cd conf subtree attr -.. LocalWords: unittest TestCase nameattr testcode staticmethod builtin +.. LocalWords: unittest TestCase nameattr testcode staticmethod builtin cp .. LocalWords: SomethingTests testFileExistsFalse testutils RunTests DQMEAN +.. LocalWords: pre