minor fixes default tip

Thu, 17 Dec 2020 10:33:19 +0100

author
David Demelier <markand@malikania.fr>
date
Thu, 17 Dec 2020 10:33:19 +0100
changeset 52
02ec33e7ca7f
parent 51
884ef6321dcc

minor fixes

CONTRIBUTE.md file | annotate | diff | comparison | revisions
STYLE.md file | annotate | diff | comparison | revisions
--- a/CONTRIBUTE.md	Tue Jan 07 11:01:27 2020 +0100
+++ b/CONTRIBUTE.md	Thu Dec 17 10:33:19 2020 +0100
@@ -1,7 +1,7 @@
-PROJECT NAME CONTRIBUTING GUIDE
+PROJECT_NAME CONTRIBUTING GUIDE
 ===============================
 
-Read this guide if you want to contribute to PROJECT NAME. The purpose of this
+Read this guide if you want to contribute to PROJECT_NAME. The purpose of this
 document is to describe the steps to submit a patch.
 
 You may submit a patch when:
@@ -17,9 +17,8 @@
 Subscribe to the mailing list
 -----------------------------
 
-Discussion and patches are sent to the *PROJECT NAME@malikania.fr* mailing list.
-You need to subscribe by dropping a mail to
-*PROJECT NAME+subscribe@malikania.fr* first.
+Discussion and patches are sent to the [*dev@*][ml] mailing list, see the
+information page about the procude.
 
 Enable patchbomb extension
 --------------------------
@@ -38,7 +37,7 @@
 
     [email]
     from = Your Name <youraddress@yourdomain.tld>
-    to = PROJECT NAME@malikania.fr
+    to = dev@malikania.fr
 
     [smtp]
     host = yourdomain.tld
@@ -79,10 +78,10 @@
 Create your patch
 -----------------
 
-Usually, when you create a patch, you should have your own copy of PROJECT NAME
+Usually, when you create a patch, you should have your own copy of PROJECT_NAME
 in your directory.
 
-The following steps assumes that you have already cloned the PROJECT NAME
+The following steps assumes that you have already cloned the PROJECT_NAME
 repository somewhere.
 
 Note: the recommended way is to create one unique revision.
@@ -97,10 +96,11 @@
 
 Replace `topic` with one of the following:
 
+- **make**: for the build system,
 - **cmake**: for the build system,
 - **doc**: for the documentation,
 - **misc**: for miscellaneous files,
-- **release**: release management,
+- **project**: for general project messages,
 - **tests**: for the unit tests.
 
 ### Quick way
@@ -243,3 +243,5 @@
 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.
+
+[ml]: http://malikania.fr/mailing-lists.html
--- a/STYLE.md	Tue Jan 07 11:01:27 2020 +0100
+++ b/STYLE.md	Thu Dec 17 10:33:19 2020 +0100
@@ -1,4 +1,4 @@
-PROJECT NAME CODING STYLE
+PROJECT_NAME CODING STYLE
 =========================
 
 File content
@@ -204,8 +204,7 @@
 ### Comments
 
 Avoid useless comments in source files. Comment complex things or why it is done
-like this. However any public function in the .h **must** be documented as
-doxygen without exception.
+like this. Do not use `//` style comments in C.
 
 ```c
 /*
@@ -213,7 +212,7 @@
  * this.
  */
 
-// Short comment
+/* Short comment. */
 ```
 
 Use `#if 0` to comment blocks of code.
@@ -248,7 +247,7 @@
 
 ### C Standard
 
-Use C99 standard without extensions.
+Use C11 standard without extensions.
 
 ### Assertions
 
@@ -462,8 +461,7 @@
 ### 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.
+like this.
 
 ```cpp
 /*
@@ -615,9 +613,9 @@
 ```cpp
 std::vector<int> v{1, 2, 3};
 
-foo({1, 2});					// type deduced
+foo({1, 2});                    // type deduced
 
-return { "true", false };	   // std::pair returned
+return { "true", false };       // std::pair returned
 ```
 
 Use the assignment for primitive types:
@@ -982,7 +980,7 @@
 -----------
 
 You can use three backticks and the language specifier or just indent a block by
-for leading spaces if you don't need syntax.
+for leading tabs if you don't need syntax.
 
 	```cpp
 	std::cout << "hello world" << std::endl;

mercurial