diff options
| author | Jussi Pakkanen <jpakkane@gmail.com> | 2014-11-16 22:52:37 +0200 |
|---|---|---|
| committer | Jussi Pakkanen <jpakkane@gmail.com> | 2014-11-16 22:52:37 +0200 |
| commit | 07896fcba93bb8b6ee6d7bc00e1fd6cb91aaccd6 (patch) | |
| tree | cf9f68043b4e186c5c83ada1988be40b3746f46c | |
| parent | 525f0ae6d252f947a512c5e0cb532617486ad649 (diff) | |
| download | meson-07896fcba93bb8b6ee6d7bc00e1fd6cb91aaccd6.zip meson-07896fcba93bb8b6ee6d7bc00e1fd6cb91aaccd6.tar.gz meson-07896fcba93bb8b6ee6d7bc00e1fd6cb91aaccd6.tar.bz2 | |
Created a contribution info file.
| -rw-r--r-- | contributing.txt | 40 | ||||
| -rw-r--r-- | readme.txt | 6 |
2 files changed, 42 insertions, 4 deletions
diff --git a/contributing.txt b/contributing.txt new file mode 100644 index 0000000..001afea --- /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. @@ -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 |