[sr-dev] git:master:a142b781: github: update contribution guidelines about our README file change process

Module: kamailio Branch: master Commit: a142b781edf2c6c22128987c32cb38b029005fe4 URL: https://github.com/kamailio/kamailio/commit/a142b781edf2c6c22128987c32cb38b… Author: Henning Westerholt <hw(a)kamailio.org> Committer: Henning Westerholt <hw(a)kamailio.org> Date: 2019-01-10T23:18:55+01:00 github: update contribution guidelines about our README file change process --- Modified: .github/CONTRIBUTING.md --- Diff: https://github.com/kamailio/kamailio/commit/a142b781edf2c6c22128987c32cb38b… Patch: https://github.com/kamailio/kamailio/commit/a142b781edf2c6c22128987c32cb38b… --- diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a09a8c0ef7..936f606017 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -67,13 +67,12 @@ and commit history, there are several *rules* required for each contribution. file. Instead, edit the xml files located in **modules/modname/doc/** folder * to regenerate the README, run **make modules-readme modules=modules/modname** * docbook utils and xsl packages are needed for the above command to work - * it is ok to modify only the xml doc file, the readme can be regenerated by - another developer who has the required tools installed - * if it is a change to README that needs to be backported, make separate - commits to xml doc file and README. The changes to README files are very - likely to rise merge conflicts. With separate commit, that won't be - backported, only the commit to xml doc file, then README will be manually - regenerated in the corresponding branch. + * it is only necessary to modify and commit the xml doc file, the **README** + will be regenerated by a automatic script that is executed every few hours + * so if you modify an existing module **README** don't commit the changes + of this file to the git repository + * if you create a new module that includes also a **README file, you + need to commit the README to the git repository one time * code **should** be formatted with **clang-format** or to match the style of the component that the commit applies to. The `.clang-format` file is part of Kamailio source code tree, in the root folder.