diff options
| author | Ron Eldor <ron.eldor@arm.com> | 2017-08-16 17:28:21 +0300 |
|---|---|---|
| committer | Ron Eldor <ron.eldor@arm.com> | 2017-08-20 16:46:43 +0300 |
| commit | 1680d3dc1929f325f80530b8eb97a11fc96296bf (patch) | |
| tree | a5d079421df5c7f075365eb5c96a6d43e1724757 /CONTRIBUTING.md | |
| parent | 7f888982fd3a2d924b890ca7c8c0d23faf7d79a1 (diff) | |
| download | mbedtls-1680d3dc1929f325f80530b8eb97a11fc96296bf.zip mbedtls-1680d3dc1929f325f80530b8eb97a11fc96296bf.tar.gz mbedtls-1680d3dc1929f325f80530b8eb97a11fc96296bf.tar.bz2 | |
Add a couple of statements to the contribution section
Add a notice for short contributions, and for Apache license header that
should be added. Added an adivce to enable the git hooks scripts as well.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfd6cb3..95219e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,8 @@ We gratefully accept bug reports and contributions from the community. There are 2. Fork the [mbed TLS repository on GitHub](https://github.com/ARMmbed/mbedtls) to start making your changes. As a general rule, you should use the "development" branch as a basis. 3. Write a test which shows that the bug was fixed or that the feature works as expected. 4. Send a pull request (PR) and work with us until it gets merged and published. Contributions may need some modifications, so a few rounds of review and fixing may be necessary. We will include your name in the ChangeLog :) +5. For quick merging, the contribution should be short, and concentrated on a single feature or topic. The larger the contribution is, the longer it would take to review it and merge it. +6. mbed TLS is release with Apache license, and as such, all the added files should include the Apache license header. ### Backports @@ -45,6 +47,7 @@ Sample applications, if needed, should be modified as well. ### Continuous Integration Tests Once a PR has been made, the Continuous Integration (CI) tests are triggered and run. You should follow the result of the CI tests, and fix failures. +It is advised to enable the [githooks scripts](https://github.com/ARMmbed/mbedtls/tree/development/tests/git-scripts) prior to pushing your changes, for catching some of the issues as early as possible. ### Documentation |