From 07896fcba93bb8b6ee6d7bc00e1fd6cb91aaccd6 Mon Sep 17 00:00:00 2001 From: Jussi Pakkanen Date: Sun, 16 Nov 2014 22:52:37 +0200 Subject: [PATCH] Created a contribution info file. --- contributing.txt | 40 ++++++++++++++++++++++++++++++++++++++++ readme.txt | 6 ++---- 2 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 contributing.txt diff --git a/contributing.txt b/contributing.txt new file mode 100644 index 000000000..001afea9b --- /dev/null +++ b/contributing.txt @@ -0,0 +1,40 @@ +Contributing to the Meson build system + +There are two simple ways to submit your patches. The preferred way is to +send a github pull request. You can also send patches as emails to the Meson +mailing list. Remember to add your name to the list of contributors +in authors.txt. + + +Coding style + +Meson follows the basic Python coding style. Additional rules are the +following: + +- indent 4 spaces, no tabs ever +- indent meson.build files with two spaces +- try to keep the code as simple as possible +- contact the mailing list before embarking on large scale projects + to avoid wasted effort + + +What not to contribute? + +There are a few things that people seem to want to add to Meson but which +are not there by design and will not be added either. + +The first one is defining your own functions or a generalised for loop. +These are bad because they would make Meson's DSL Turing complete. The +second feature is a Make backend. + +The FAQ has specific information why these two features will not be +added to Meson: https://github.com/jpakkane/meson/wiki/FAQ + +Merge requests adding either of these two features will be automatically +rejected. Please save everyone's time (especially your own) and don't start +working on these features. + + +Do I need to sign a CLA? + +No. All contributions are welcome. diff --git a/readme.txt b/readme.txt index e79ac7e24..869a9692f 100644 --- a/readme.txt +++ b/readme.txt @@ -50,10 +50,8 @@ you may need to run this command with sudo. Contributing -We love community contributions. There are two simple ways to submit your -patches. The preferred way is to send a github pull request. You can -also send patches as emails to the Meson mailing list. Remember to add -your name to the list of contributors in authors.txt. +We love code contributions. See the contributing.txt file for +details. Further info