Module: kamailio
Branch: master
Commit: 04d082d2a89f8e0d3646856cb81666f9f03fdffa
URL: https://github.com/kamailio/kamailio/commit/04d082d2a89f8e0d3646856cb81666f…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2020-03-04T11:39:02+01:00
CONTRIBUTING.md: section for first line of the commit message [skip ci]
- note about [skip ci] flag in first line
---
Modified: .github/CONTRIBUTING.md
---
Diff: https://github.com/kamailio/kamailio/commit/04d082d2a89f8e0d3646856cb81666f…
Patch: https://github.com/kamailio/kamailio/commit/04d082d2a89f8e0d3646856cb81666f…
---
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index f90d1c492b..fca94e33de 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -81,13 +81,20 @@ Please create the commit messages following the GIT convention:
* start with one short line, preferably less then 50 chars summarizing the
changes (this is referred later as "first line of the commit message")
* then one empty line
- * then a more detailed description
+ * then a more detailed description (the "commit message content")
+
+#### First Line Of The Commit Message ####
Think of the first line as of an email "Subject" line. In fact it will be used
as "Subject" in the generated commit emails and it will also be used when
generating the Changelog (e.g. git log --pretty=oneline).
-Please start always with the prefix of the component (subsystem) that is modified by the commit, for example:
+
+The first line (subjecthas to contain meaningful text about what that commit
+does, do not put just a reference to bug tracker or pull request items
+
+Please start always with the prefix of the component (subsystem) that is modified
+by the commit, for example:
* `core`: more fixup helper functions
* `core`: tcp - support for haproxy protocol
* `core`: mem - added faster malloc
@@ -96,13 +103,19 @@ Please start always with the prefix of the component (subsystem) that is modifie
* `lib`: srutils - critical bug fix for abc case
* `kamctl`: added support for management of module xyz
+At the end of the first line some CI flags can be added. Available at this
+moment:
+
+ * `[skip ci]` - skip continous integration builds for source code, recommended
+ to be added when updating documentation, example configs or other utilities.
+ Example:
+ * `msilo: docs - updated example for m_dump() function [skip ci]`
+
#### Commit Message Content ####
- * first line (subject line) has to contain meaningful text about what that commit
- does, do not put just a reference to bug tracker or pull request items
- * commit message must describe the changes done by the patch
+* commit message must describe the changes done by the patch
* other details (e.g., how to reproduce, backtrace, sip packets, ...) belong
- to content (comments) of the pull request. Example:
+ to content (comments) of the pull request. Example of a full commit message:
```
core: added latency_limit_cfg global parameter
<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [ ] Commit message has the format required by CONTRIBUTING guide
- [x] Commits are split per component (core, individual modules, libs, utils, ...)
- [x] Each component has a single commit (if not, squash them into one commit)
- [x] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
<!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/2238
-- Commit Summary --
* acc_json: doc fixes
* usrloc: doc fixes
* tm: docs - fix title for parameter event_callback_lres_sent
* websocket: docs - fix title for parameter rm_delay_interval
-- File Changes --
M src/modules/acc_json/doc/acc_json_admin.xml (29)
M src/modules/tm/doc/params.xml (2)
M src/modules/usrloc/doc/usrloc_admin.xml (22)
M src/modules/websocket/doc/websocket_admin.xml (2)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/2238.patchhttps://github.com/kamailio/kamailio/pull/2238.diff
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/2238
Module: kamailio
Branch: master
Commit: 32a21b5bd17309175ba99186629fa0d4e6b21fa7
URL: https://github.com/kamailio/kamailio/commit/32a21b5bd17309175ba99186629fa0d…
Author: Bastian Triller <bastian.triller(a)gmail.com>
Committer: Bastian Triller <bastian.triller(a)gmail.com>
Date: 2020-03-04T10:26:42+01:00
tm: docs - fix title for parameter event_callback_lres_sent
---
Modified: src/modules/tm/doc/params.xml
---
Diff: https://github.com/kamailio/kamailio/commit/32a21b5bd17309175ba99186629fa0d…
Patch: https://github.com/kamailio/kamailio/commit/32a21b5bd17309175ba99186629fa0d…
---
diff --git a/src/modules/tm/doc/params.xml b/src/modules/tm/doc/params.xml
index 4c583ca782..512e7d40a0 100644
--- a/src/modules/tm/doc/params.xml
+++ b/src/modules/tm/doc/params.xml
@@ -1440,7 +1440,7 @@ end
</section>
<section id="tm.p.event_callback_lres_sent">
- <title><varname>event_callback_lres</varname> (str)</title>
+ <title><varname>event_callback_lres_sent</varname> (str)</title>
<para>
The name of the function in the kemi configuration file (embedded
scripting language such as Lua, Python, ...) to be executed instead