mention one-sentence-per-line style for docs (#71)

colcon · May 19, 2020 · 3d0c359 · 3d0c359
1 parent 74a8598
commit 3d0c359
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/developer/contribution.rst b/developer/contribution.rst
@@ -33,6 +33,13 @@ Pull requests
 * Make sure that the code changes pass the existing tests including the linters.
 * And as a last step create a pull request.
 
+Documentation
+-------------
+
+Since documentation is stored in a git repository any changes are made through pull requests and therefore the above bullets for pull requests apply.
+
+The documentation follows the one-sentence-per-line style to minimize the diff (preventing reflow in a paragraph on changes).
+
 New packages / extensions
 -------------------------
 

diff --git a/spelling_wordlist.txt b/spelling_wordlist.txt
@@ -31,6 +31,7 @@ prepend
 prepended
 pytest
 refactored
+reflow
 regex
 setuppy
 subdirectories