Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[doc] CONTRIBUTING: added a CONTRIBUTING.md file to support github co…

…ntributing guidelines, which is a merge of GUIDELINES and DOCUMENTATION
  • Loading branch information...
commit 88296ddd3f80fb4d7d6423f102f38a84666a68ba 1 parent b9fca6b
@Aqua-Ye Aqua-Ye authored
Showing with 42 additions and 38 deletions.
  1. +42 −1 doc/DOCUMENTATION → CONTRIBUTING.md
  2. +0 −37 doc/GUIDELINES
View
43 doc/DOCUMENTATION → CONTRIBUTING.md
@@ -1,4 +1,44 @@
-Opa Documentation format :
+# Naming conventions:
+
+* the language is called Opa, not OPA or opa;
+* respectively, other languages are called JavaScript, OCaml, HTML, PHP;
+* the BSL is the Binding System Library;
+
+# Spelling conventions:
+* we are writing in American, so use the "z" of your keyboard;
+* full words, please, not "we're" but "we are", no "it's" but "it is", etc.
+
+# Chapter conventions:
+* tutorials start with "Hello"
+
+# Convention for source code:
+* source code must fit in 80 columns;
+* source must be fully commented, in Opadoc style;
+* keywords are between ++
+
+# Typography:
+* don't forget semi-colons;
+* in lists, they are compulsory.
+
+# Git commits:
+* commit messages must respect the following format:
+ * [tag] context: message
+* where allowed tags are:
+ * cleanup, contrib, debug, doc, enhance, feature, fix, layout, revert.
+
+# ChangeLog conventions:
+
+YEAR.MONTH.DAY, Version SEMVER (stability), GIT_HASH
+
+* change 1
+ - description
+
+* change 2
+
+* change 3
+
+<!--
+# Opa Documentation format :
/**
* {1 Tests}
@@ -125,3 +165,4 @@ Opa Documentation format :
* {custom custom tag}
* }
*/
+-->
View
37 doc/GUIDELINES
@@ -1,37 +0,0 @@
-Naming conventions:
-* the language is called Opa, not OPA or opa;
-* respectively, other languages are called JavaScript, OCaml, HTML, PHP;
-* the BSL is the Binding System Library;
-
-Spelling conventions:
-* we are writing in American, so use the "z" of your keyboard;
-* full words, please, not "we're" but "we are", no "it's" but "it is", etc.
-
-Chapter conventions:
-* tutorials start with "Hello"
-
-Convention for source code:
-* source code must fit in 80 columns;
-* source must be fully commented, in Opadoc style;
-* keywords are between ++
-
-Typography:
-* don't forget semi-colons;
-* in lists, they are compulsory.
-
-Git commits:
-* commit messages must respect the following format:
-* [tag] context: message
-* where allowed tags are:
-* cleanup, contrib, debug, doc, enhance, feature, fix, layout, revert.
-
-ChangeLog conventions:
-
-YEAR.MONTH.DAY, Version SEMVER (stability), GIT_HASH
-
-* change 1
- - description
-
-* change 2
-
-* change 3
Please sign in to comment.
Something went wrong with that request. Please try again.