From f924005733f732c2750a5d2c651356cf3893513c Mon Sep 17 00:00:00 2001 From: Carles Fernandez Date: Sat, 3 Mar 2018 11:52:27 +0100 Subject: [PATCH] Add mention to http://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting --- CONTRIBUTING.md | 3 +++ docs/PULL_REQUEST_TEMPLATE.md | 5 +++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12cc1328f..3268e8657 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -128,6 +128,9 @@ $ git pull --rebase upstream next ### How to submit a pull request +Before submitting you code, please be sure to apply clang-format +(see http://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting). + When the contribution is ready, you can [submit a pull request](https://github.com/gnss-sdr/gnss-sdr/compare/). Head to your GitHub repository, switch to your `my_feature` branch, and click the diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md index b4e04e2c1..bb69db911 100644 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,8 @@ Before submitting your pull request, please make sure the following is done: 2. If you are a first-time contributor, after your pull request you will be asked to sign an Individual Contributor License Agreement ([CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement)) before your code gets accepted into `master`. This license is for your protection as a Contributor as well as for the protection of [CTTC](http://www.cttc.es/); it does not change your rights to use your own contributions for any other purpose. Except for the license granted therein to CTTC and recipients of software distributed by CTTC, you reserve all right, title, and interest in and to your contributions. The information you provide in that CLA will be maintained in accordance with [CTTC's privacy policy](http://www.cttc.es/privacy/). 3. You have read the [Contributing Guidelines](https://github.com/gnss-sdr/gnss-sdr/blob/master/CONTRIBUTING.md). 4. You have read the [coding style guide](http://gnss-sdr.org/coding-style/). - 5. You have forked the [gnss-sdr upstream repository](https://github.com/gnss-sdr/gnss-sdr) and have created your branch from `next` (or any other currently living branch in the upstream repository). - 6. Please include a description of your changes here. + 5. Specifically, you have read [about clang-format](http://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting) and you have applied it. + 6. You have forked the [gnss-sdr upstream repository](https://github.com/gnss-sdr/gnss-sdr) and have created your branch from `next` (or any other currently living branch in the upstream repository). + 7. Please include a description of your changes here. **Please feel free to delete this line and the above text once you have read it and in case you want to go on with your pull request.** \ No newline at end of file