Merge: Added contributing guidelines and link from readme

As discussed in #2133, contribution guidelines are hard to find.

This PR is an attempt to ease the process by giving newcomer friendly advices and some more insight on the contribution process for Nit.

@tonygaetani, do you think a document like this one would have been helpful for you ? Is there anything you would change to make it friendlier/clearer ?

Close #2133

Pull-Request: #2134
Reviewed-by: Jean Privat <jean@pryen.org>

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..8850808
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# Contributing to Nit
+
+Thank you for your interest in contributing to Nit!
+We accept all forms of contribution, ranging from small example programs to improvements and additions to the libraries and posting of issues.
+
+
+## Contribution process
+
+All the contributions to the Nit language, its tools and libraries, are done through Github Pull-Requests.
+
+All the information on our contribution policy is available on our [website](http://nitlanguage.org/internal/).
+We encourage you to take a look at the sections available here for a walthrough of what is required to submit a new PR.
+
+## Other suggestions
+
+We are always open for suggestions or any other kind of contribution.
+
+If you do not want to submit code for some reason, you are always welcome to ask questions about the language or related topics via the issue system.
+
+You may also proof-read and correct documentation if you are willing!
+All the documents on this repository are written in English, however most of our contributors are not native anglophones.
+Therefore we encourage people, especially those coming of an english-speaking culture to read the documentation available and submit patches to correct bad formulations, typos or related mistakes on our part through the usual system.

diff --git a/README.md b/README.md
index 1a5dd3c..2679f4d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -65,6 +65,11 @@ To have your environment automatically configured at login, just source it with
 
     $ . misc/nit_env.sh install
 
+Contributing:
+
+To contribute to Nit, please see [CONTRIBUTING](CONTRIBUTING.md).
+
+The best way to ask the team for advice, submit bugs or request features, is through the use of Github issues, using the appropriate tag (`forum`, `feature-request`, `bug`).
 
 Information, contacts and help: