From c09d42e841a7fcf84f3e1bd9f35903f7c78f97f4 Mon Sep 17 00:00:00 2001
From: jao <jao@gnu.org>
Date: Sat, 19 Feb 2022 12:26:42 +0000
Subject: More documentation nits

---
 contributing.org | 69 ++++++++++++++++++++++++++++----------------------------
 1 file changed, 35 insertions(+), 34 deletions(-)

diff --git a/contributing.org b/contributing.org
index 14bce0d..b94392e 100644
--- a/contributing.org
+++ b/contributing.org
@@ -1,4 +1,4 @@
-* Contributing Changes/Patches to xmobar
+#+title: Contributing to xmobar
 
 Want to contribute to xmobar? You've come to the right place! This
 document will help guide you in this endeavour.
@@ -8,46 +8,47 @@ best to talk with the community first. Currently the best way to do that
 is to [[https://github.com/jaor/xmobar/issues/new][create an issue]] on GitHub. There, you can talk through the
 problems you are having, as well as the proposed solution.
 
-** Making the Change
+*** Making the change
 
-It's best to create a separate branch in your clone of the [[https://github.com/jaor/xmobar/][xmobar repo]]
-and then push this branch to your fork.
+    It's best to create a separate branch in your clone of the [[https://github.com/jaor/xmobar/][xmobar
+    repo]] and then push this branch to your fork.
 
-If your pull request undergoes several iterations and =master= has
-changed in the meantime, you may be asked to rebase on top of it; in
-this case please don't merge any branches, but actually rebase! This is
-a very nifty feature that =git= offers in order to remain a clean
-history.
+    If your pull request undergoes several iterations and =master= has
+    changed in the meantime, you may be asked to rebase on top of it;
+    in this case please don't merge any branches, but actually rebase!
+    This is a very nifty feature that =git= offers in order to remain a
+    clean history.
 
-Give your commits descriptive names!  Further, it's also highly
-recommended to add a description of /why/ you made a certain change.
-The syntax for this is *commit message*, blank line, *more description*.
-For example:
+    Give your commits descriptive names!  Further, it's also highly
+    recommended to add a description of /why/ you made a certain change.
+    The syntax for this is *commit message*, blank line, *more
+    description*.  For example:
 
-  #+begin_src shell
-    Commit Message (max. 50 characters)
+    #+begin_src shell
+      Commit Message (max. 50 characters)
 
-    Some more useful information of why this change was made; possibly
-    how it connects with other commits in this same pr (wrapped at 72
-    characters).
-  #+end_src
+      Some more useful information of why this change was made;
+      possibly how it connects with other commits in this same pr
+      (wrapped at 72 characters).
+     #+end_src
 
-** Opening a Pull Request
+*** Opening a pull request
 
-Once you have pushed the branch to your fork, making a pull request is
-as easy as visiting that branch; GitHub will then even prompt you for
-it!
+    Once you have pushed the branch to your fork, making a pull
+    request is as easy as visiting that branch; GitHub will then even
+    prompt you for it!
 
-Please include the following information in the description of your pull
-request:
+    Please include the following information in the description of
+    your pull request:
 
-- Does your pull request close, or is related to, any existing issues?
-- What does your pull request do?  If you add a new feature, an example
-  of how you would use it would be most appreciated.
-- A brief summary of how your commits fit together to achieve this (if
-  necessary).
+    - Does your pull request close, or is related to, any existing
+      issues?
+    - What does your pull request do?  If you add a new feature, an
+      example of how you would use it would be most appreciated.
+    - A brief summary of how your commits fit together to achieve this
+      (if necessary).
 
-Please also remember to update the =changelog.md= file, as well as any
-other documentation that your pull request touches upon.  For example,
-if you add a new plugin (see [[./doc/write-your-own-plugin.org][here]] for more information) you should
-update the [[./doc/plugins.org][plugins documentation]].
+    Please also remember to update the =changelog.md= file, as well as
+    any other documentation that your pull request touches upon.  For
+    example, if you add a new plugin (see [[./doc/write-your-own-plugin.org][here]] for more information)
+    you should update the [[./doc/plugins.org][plugins documentation]].
-- 
cgit v1.2.3