Official NixOS Wiki:Contributing: Difference between revisions

Line 14:

===Language===

NixOS ~~wiki~~ articles should be written in clear, standard and professional language. To this end, the following considerations apply:

NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:

* ''Vocabulary'': use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.

Line 20:

* ''Citations'': citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.

* ''Attribution'': where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.

* ''~~Code~~'': code examples should be minimal, to-the-point, and illustrative of the surrounding text.

===Code===

Articles can and often should contain plenty of code snippets and blocks. When using code consider the following:

* ''Quantity'': code examples should be minimal, to-the-point, and only used when illustrative of the surrounding text.

* ''Style'': code should be properly indented with clear naming and commenting where necessary.

== Tagging Articles ==

@@ Line 14: / Line 14: @@
 ===Language===
-NixOS wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:
+NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:
 * ''Vocabulary'': use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
@@ Line 20: / Line 20: @@
 * ''Citations'': citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
 * ''Attribution'': where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.
-* ''Code'': code examples should be minimal, to-the-point, and illustrative of the surrounding text.
+===Code===
+Articles can and often should contain plenty of code snippets and blocks. When using code consider the following:
+* ''Quantity'': code examples should be minimal, to-the-point, and only used when illustrative of the surrounding text.
+* ''Style'': code should be properly indented with clear naming and commenting where necessary.
 == Tagging Articles ==