sites

commit 0ff53d75a9834d3a71dc63ea600e6b8af354b844
parent 719724ac9c2208789e6cdff16d9583012f4dbfec
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date:   Sun, 16 Aug 2020 13:16:19 +0200

wiki rules/guidelines: update page

Diffstat:
M
suckless.org/wiki/index.md
 | 
34
+++++++++++++++++++++++++++-------

1 file changed, 27 insertions(+), 7 deletions(-)
diff --git a/suckless.org/wiki/index.md b/suckless.org/wiki/index.md
@@ -15,7 +15,7 @@ used on suckless.org is
 
 For adding new files, after you created them, use:
 
-	git add $filename
+	git add somefile
 
 When you are finished, commit your changes with:
 
@@ -28,8 +28,8 @@ use:
 
 	git push git://git.suckless.org/sites
 
-The review of your changes might take one day, due to the different timezones
-we all live in.
+The review of your changes might take a few days, due to the different
+timezones we all live in.
 
 __Please make sure to update for incoming changes using »git pull«, before you
 push changes, to minimize merge problems.__
@@ -42,11 +42,28 @@ Rules
   mind! We kindly ask you to not destroy the way we like to collaborate with
   the community.
 * Please do not add files bigger than *100kb*.
-* Please do not add unscaled large images.
+* Please do not add unscaled large images. If needed provide a thumbnail.
 * Please do not add any binary files except screenshots or images related to
-  our software. The patches should be hosted in the repository itself.
-* The extension of newly created Markdown files has to be `.md`.
+  our software.
+* The patches should be hosted in the repository itself. Providing an
+  additional mirror with the same content is OK.
 * Inline HTML, HTML files or inline JavaScript is not allowed and not supported.
+
+Commit messages
+---------------
+Try to provide a clear subject and a clear commit message.
+The subject should not be more than 79 characters.
+
+The format should be:
+
+Subject not more than 79 characters<newline>
+<newline>
+Clear message describing the commit, line-wrapped to maximum of 79 characters.
+This message can be optional for trivial commits.
+
+Markdown usage
+--------------
+* The extension of newly created Markdown files must be `.md`.
 * There are some dialects of Markdown, please don't use too "advanced" features.
 
 Review markdown
@@ -55,6 +72,9 @@ A quick way to check what output will be generated on the site is to do:
 
 	smu -n < index.md | lynx -stdin
 
+Please review your changes locally before pushing to avoid spamming the commit
+log and the review process.
+
 Changes
 -------
 The incoming changes to the wiki are all sent to the wiki@
@@ -76,4 +96,4 @@ Repositories
 This is for moderators.
 
 To create a new repository just git init --bare and symlink the git hooks (see
-the hooks/ directory in other projects).
+the hooks/ directory in the other projects).