diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2018-07-02 19:14:09 +0530 |
|---|---|---|
| committer | Nirbheek Chauhan <nirbheek@centricular.com> | 2018-07-02 19:52:53 +0530 |
| commit | d6a9b4cc793707d92055abd4086cf6240bfae1f3 (patch) | |
| tree | c4c3845f105bc6bd63c52feeb848a22089ca9655 /docs/markdown/Contributing.md | |
| parent | a1d9adba096589122aefc50fb9429ec0ce0432b9 (diff) | |
| download | meson-d6a9b4cc793707d92055abd4086cf6240bfae1f3.tar.gz | |
Contributing.md: Document procedure for new features [skip ci]
Diffstat (limited to 'docs/markdown/Contributing.md')
| -rw-r--r-- | docs/markdown/Contributing.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index 7559c001b..e385be298 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -29,6 +29,20 @@ Do not merge head back to your branch. Any merge commits in your pull request make it not acceptable for merging into master and you must remove them. +## Special procedure for new features + +Every new feature requires some extra steps, namely: + + - Must include a project test under `test cases/`, or if that's not + possible or if the test requires a special environment, it must go + into `run_unittests.py`. + - Must be registered with the [FeatureChecks framework](Release-notes-for-0.47.0.md#Feature_detection_based_on_meson_version_in_project) + that will warn the user if they try to use a new feature while + targetting an older meson version. + - Needs a release note snippet inside `docs/markdown/snippets/` with + a heading and a brief paragraph explaining what the feature does + with an example. + ## Acceptance and merging The kind of review and acceptance any merge proposal gets depends on |