Pārlūkot izejas kodu

add file names to general guidelines

LB Johnston 2 gadi atpakaļ
vecāks
revīzija
bdf0f21fdb

+ 14 - 0
docs/contributing/general_guidelines.md

@@ -0,0 +1,14 @@
+# General coding guidelines
+
+## Language
+
+British English is preferred for user-facing text; this text should also be marked for translation (using the `django.utils.translation.gettext` function and `{% trans %}` template tag, for example). However, identifiers within code should use American English if the British or international spelling would conflict with built-in language keywords; for example, CSS code should consistently use the spelling `color` to avoid inconsistencies like `background-color: $colour-red`.
+
+## File names
+
+Where practical, try to adhere to the existing convention of file names within the folder where added.
+
+Examples:
+
+-   Django templates - `lower_snake_case.html`
+-   Documentation - `lower_snake_case.md`

+ 0 - 7
docs/contributing/general_guidelines.rst

@@ -1,7 +0,0 @@
-General coding guidelines
-=========================
-
-Language
-~~~~~~~~
-
-British English is preferred for user-facing text; this text should also be marked for translation (using the ``django.utils.translation.gettext`` function and ``{% trans %}`` template tag, for example). However, identifiers within code should use American English if the British or international spelling would conflict with built-in language keywords; for example, CSS code should consistently use the spelling ``color`` to avoid inconsistencies like ``background-color: $colour-red``.