diff options
Diffstat (limited to 'contributing.md')
-rw-r--r-- | contributing.md | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/contributing.md b/contributing.md index 1f1d73c36a..b628b3921e 100644 --- a/contributing.md +++ b/contributing.md @@ -2,27 +2,29 @@ Contributions to TF-M project need to follow the process below. -`Note` Please contact [Maintainers](../maintainers.md) for any questions. +`Note` Please contact [Maintainers](./maintainers.md) for any questions. -- Create an issue in http://issues.trustedfirmware.org +- Create an issue in [http://issues.trustedfirmware.org](http://issues.trustedfirmware.org) to keep others informed about your ongoing work. - If it is a major change then please discuss the design with maintainers. -- Clone the TF-M code on your own machine from http://git.trustedfirmware.org/trusted-firmware-m.git/ +- Clone the TF-M code on your own machine from + [http://git.trustedfirmware.org/trusted-firmware-m.git](http://git.trustedfirmware.org/trusted-firmware-m.git) - Follow the [Coding Guidelines](docs/coding_guide.md) for the TF-M project. - Make your changes in logical chunks to help reviewers. - Update relevant documentation. - Test your changes and add details to the commit description. - Add the issue number and details to commit description as well. -- The code is accepted under [DCO](../dco.txt), Developer Certificate +- The code is accepted under [DCO](./dco.txt), Developer Certificate of Origin, so you must add following fields to your commit description. - ``` - Author: Full Name <email address> - Signed-off-by: Full Name <email address> +``` + Author: Full Name <email address> + Signed-off-by: Full Name <email address> - Note: Sign off authority needs to adhere to the [DCO](../dco.txt) rules. - ``` + Note: Sign off authority needs to adhere to the [DCO](./dco.txt) rules. +``` - You may add other fields in the commit message. -- Submit your patch for review at http://review.trustedfirmware.org +- Submit your patch for review at + [http://review.trustedfirmware.org](http://review.trustedfirmware.org) - Maintainers will be notified and they will start review process. - You may be asked to provide further details or make additional changes. - You can discuss further with maintainer(s) offline if necessary. |