changeset 409:c363c09e1f44

Misc: add CONTRIBUTE.md and STYLE.md
author David Demelier <markand@malikania.fr>
date Wed, 25 Jan 2017 13:29:11 +0100
parents 35c40ac0dc26
children 7b671bd1ff43
files CMakeLists.txt CONTRIBUTE.md STYLE.md
diffstat 3 files changed, 295 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/CMakeLists.txt	Fri Jan 20 09:35:57 2017 +0100
+++ b/CMakeLists.txt	Wed Jan 25 13:29:11 2017 +0100
@@ -147,3 +147,15 @@
 
 include(cmake/IrccdPackage.cmake)
 include(CPack)
+
+# Metadata files
+add_custom_target(
+    metadata
+    SOURCES
+        ${CMAKE_SOURCE_DIR}/CHANGES.md
+        ${CMAKE_SOURCE_DIR}/CONTRIBUTE.md
+        ${CMAKE_SOURCE_DIR}/CREDITS.md
+        ${CMAKE_SOURCE_DIR}/INSTALL.md
+        ${CMAKE_SOURCE_DIR}/README.md
+        ${CMAKE_SOURCE_DIR}/STYLE.md
+)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CONTRIBUTE.md	Wed Jan 25 13:29:11 2017 +0100
@@ -0,0 +1,170 @@
+IRC Client Daemon CONTRIBUTING GUIDE
+====================================
+
+Read this guide if you want to contribute to irccd. The purpose of this document
+is to describe the steps to submit a patch.
+
+You may submit a patch when:
+
+  - You want to fix a bug / typo,
+  - You want to add a new feature,
+  - You want to change something.
+
+There a lot of steps before submitting a patch. First, be sure to respect the
+style defined in the STYLE.md file. We never accept patches that do not match
+the rules.
+
+Subscribe to the mailing list
+-----------------------------
+
+Discussion and patches are sent to the *irccd (at) malikania (dot) fr* mailing
+list. You need to subscribe by dropping a mail to
+*irccd+subscribe (at) malikania (dot) fr* first.
+
+Create your patch
+-----------------
+
+Usually, when you create a patch, you should have your own copy of irccd in your
+directory.
+
+The following steps assumes that you have already cloned the irccd repository
+somewhere.
+
+**Note**: the recommended way is to create one unique revision.
+
+### Quick way
+
+If you plan to create a very small patch that consists of several lines, you can
+use the following way by disabling the @ bookmark to avoid moving it.
+
+    $ hg pull           # fetch last changesets
+    $ hg up @           # update to the last revision
+    $ hg book -i @      # disable the @ bookmark (optional but recommended)
+    (edit some files)
+    $ hg commit         # create a unique revision
+    $ hg email -r .     # send a mail about the current revision (interactive)
+
+### Bookmark way
+
+We use Mercurial bookmarks as our workflow but we do share only @ bookmark
+except when a long feature is being developed in parallel. Otherwise bookmarks
+stay locally most of the time.
+
+When you start working on a new feature, you **must** always start from the @
+bookmark.
+
+You can use this workflow if you plan to create a patch that consists of
+multiple revisions.
+
+Example:
+
+    $ hg pull
+    $ hg up @
+    $ hg book feature-xyz
+    (work)
+    $ hg commit
+    (work)
+    $ hg commit
+    $ hg email -r first:last
+
+Here, you must specify **first** and **last** as the initial and last revisions
+respectively. You can check these revisions using `hg log` (also try `hg log -G`
+or the nice TortoiseHg interface).
+
+Example, I've started to work on an a feature named **feature-xyz**, the log
+looks like this:
+
+    changeset:   22:3fb15d8fc454
+    bookmark:    feature-xyz
+    tag:         tip
+    user:        François Jean <fj@gmail.com>
+    date:        Thu Dec 08 16:08:40 2016 +0100
+    summary:     Irccdctl: do the same for irccdctl
+
+    changeset:   21:f27e577c5504
+    user:        François Jean <fj@gmail.com>
+    date:        Thu Dec 08 16:03:06 2016 +0100
+    summary:     Irccd: added initial support for multiple connections
+
+    changeset:   20:777023816ff9
+    bookmark:    @
+    user:        David Demelier <markand@malikania.fr>
+    date:        Thu Dec 08 16:02:26 2016 +0100
+    summary:     Misc: fix a bug
+
+The two revisions I want to export are 21 and 22, so I use `hg email -r 21:22`,
+once done, see the section below.
+
+Additional topics
+-----------------
+
+### Your patch is accepted
+
+The safest choice is to just pull from the central repository and update to the
+@ bookmark.
+
+    $ hg pull
+    $ hg up @
+
+You can also call `hg rebase` (from rebase extension) to move your revisions on
+top of upstream. If the patches were incorporated verbatim, they will be safely
+discarded automatically.
+
+    $ hg pull
+    $ hg up @
+    $ hg rebase -b feature-xyz -d @
+    $ hg book -d feature-xyz
+
+If you didn't created a bookmark replace **feature-xyz** with your revision
+number.
+
+Finally, if you prefer to remove the revisions you have created, use `hg strip`
+like explained in the see section below.
+
+### Your patch is discarded
+
+For some reasons, your patch can not be integrated within the official
+repository, you can remove the revisions you have commited or keep them.
+
+If you want to remove the revisions, you can use the `hg strip` command (from
+the strip extension.
+
+**Warning**: it will **remove** the revisions from history so use with care.
+
+    $ hg strip -r 21:22         # using the example above
+    $ hg book -d feature-xyz    # delete the bookmark
+
+You can just go back on the @ bookmark as it's the safest choice.
+
+    $ hg pull                   # fetch changesets
+    $ hg up @                   # update to @
+
+### How to merge upstream code to continue my patch
+
+Sometimes when you started working on a topic, you may need to pull changes from
+the repository. The idea is to pull the changes and rebase your work on top of
+it.
+
+You must run these commands while your bookmark is active
+
+    $ hg up feature-xyz
+    $ hg pull -B @
+    $ hg rebase -b feature-xyz -d @
+
+### I forgot to create a bookmark and accidentally moved the @ bookmark
+
+If you forgot to create a custom bookmark or disable @ before committing, you
+may have moved the @ bookmark in your repository. The `hg pull` command can
+recover it.
+
+First, we create it now to point at your local revisions (optional).
+
+    $ hg book feature-xyz
+
+Then, put it where it should be.
+
+    $ hg pull -B @
+
+Now @ will be placed to the same revision as the central repository. If some
+changesets have been pulled, you may look at the previous topic to rebase your
+work on top of it.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/STYLE.md	Wed Jan 25 13:29:11 2017 +0100
@@ -0,0 +1,113 @@
+IRC Client Daemon CODING STYLE
+==============================
+
+General rules
+-------------
+
+  - Never write two blank consecutives blank lines,
+  - No jokes,
+  - No easter eggs.
+
+Style
+-----
+
+  - Always use 4 spaces as indentation,
+  - Do not exceed 120 characters for lines of code,
+  - Do not exceed 80 characters for comments.
+
+### Braces
+
+Braces follow the K&R style, they are never placed on their own lines except for
+function definitions.
+
+In addition to the K&R style, they are required everywhere even if a block
+contains only one statement.
+
+    if (condition) {
+        apply();
+        add();
+    } else {
+        ok();
+    }
+
+    if (condition) {
+        validate();
+    }
+
+And a lambda has its braces on the same lines too:
+
+    sort([&] (object&) {
+        return true;
+    });
+
+### Naming
+
+  - English names,
+  - Member variables starts with `m_`,
+  - No hungarian notation.
+
+All functions, variables, class names are always camelCase. Only namespaces must
+be all lowercase, short and concise. Please note that you should not create a
+new namespace except irccd and anonymous ones.
+
+    int m_variable;
+
+    void myFunction()
+    {
+    }
+
+### Files
+
+  - Use `.cpp` and `.hpp` as file extensions,
+  - Filenames are all lowercase.
+
+### Comments
+
+Avoid useless comments in source files. Comment complex things or why it is done
+like this. However any public function in the .hpp **must** be documented as
+doxygen without exception.
+
+    /*
+     * Multi line comments look like
+     * this.
+     */
+
+    // Short comment
+
+### Includes
+
+The includes should always come in the following order.
+
+  1. C++ headers
+  2. C header
+  3. Third party libraries
+  4. Application headers in ""
+
+    #include <cstring>
+    #include <cerrno>
+
+    #include <sys/stat.h>
+
+    #include <libircclient.h>
+
+    #include "foo.h"
+
+**Note**: always use C++ headers for C equivalent, stdio.h -> cstdio, etc.
+
+### Commit messages
+
+Commit messages are written using the following syntax:
+
+    Topic: short message less than 80 characters
+
+    Optional additional description if needed.
+
+Replace `Topic` with one of the following:
+
+  - **CMake**: for the build system,
+  - **Docs**: for the documentation,
+  - **Irccd**: for the `irccd(1)` daemon,
+  - **Irccdctl**: for the `irccdctl(1)` utility,
+  - **Misc**: for miscellaneous files,
+  - **Tests**: for the unit tests,
+  - **Plugin xyz**: for a specific plugin (e.g. Plugin hangman:).