Skip to content

Commit

Permalink
Add a couple of statements to the contribution section
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Ron Eldor committed Aug 20, 2017
1 parent 7f88898 commit 1680d3d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down

0 comments on commit 1680d3d

Please sign in to comment.