Added contrib to rate_cacher

OpenSIPS · Mar 24, 2020 · 1352823 · 1352823
1 parent a0d3f3b
commit 1352823
Show file tree

Hide file tree

Showing 3 changed files with 138 additions and 0 deletions.
diff --git a/modules/rate_cacher/README b/modules/rate_cacher/README
@@ -57,6 +57,22 @@ RATE_CACHER Module
               1.5.9. rc_deleteClientRate
               1.5.10. rc_getClientPrice
 
+   2. Contributors
+
+        2.1. By Commit Statistics
+        2.2. By Commit Activity
+
+   3. Documentation
+
+        3.1. Contributors
+
+   List of Tables
+
+   2.1. Top contributors by DevScore^(1), authored commits^(2) and
+          lines added/removed^(3)
+
+   2.2. Most recently active contributors^(1) to this module
+
    List of Examples
 
    1.1. Setting the vendors_db_url parameter
@@ -593,3 +609,44 @@ y use $avp(out_vendor_result) , in the provided order\n");
     "increment": 1,
     "currency": "USD"
 }
+
+
+Chapter 2. Contributors
+
+2.1. By Commit Statistics
+
+   Table 2.1. Top contributors by DevScore^(1), authored
+   commits^(2) and lines added/removed^(3)
+              Name          DevScore Commits Lines ++ Lines --
+   1. Vlad Paiu (@vladpaiu)    27       1      3164      0
+
+   (1) DevScore = author_commits + author_lines_added /
+   (project_lines_added / project_commits) + author_lines_deleted
+   / (project_lines_deleted / project_commits)
+
+   (2) including any documentation-related commits, excluding
+   merge commits. Regarding imported patches/code, we do our best
+   to count the work on behalf of the proper owner, as per the
+   "fix_authors" and "mod_renames" arrays in
+   opensips/doc/build-contrib.sh. If you identify any
+   patches/commits which do not get properly attributed to you,
+   please submit a pull request which extends "fix_authors" and/or
+   "mod_renames".
+
+   (3) ignoring whitespace edits, renamed files and auto-generated
+   files
+
+2.2. By Commit Activity
+
+   Table 2.2. Most recently active contributors^(1) to this module
+              Name            Commit Activity
+   1. Vlad Paiu (@vladpaiu) Mar 2020 - Mar 2020
+
+   (1) including any documentation-related commits, excluding
+   merge commits
+
+Chapter 3. Documentation
+
+3.1. Contributors
+
+   Last edited by: Vlad Paiu (@vladpaiu).
diff --git a/modules/rate_cacher/doc/contributors.xml b/modules/rate_cacher/doc/contributors.xml
@@ -0,0 +1,79 @@
+<!-- THIS IS AN AUTO-GENERATED FILE -->
+<chapter id="contributors" xreflabel="contributors">
+    <title>&contributors;</title>
+
+<section id="contrib_commit_statistics" xreflabel="contrib_commit_statistics">
+	<title>By Commit Statistics</title>
+
+	<table frame='all'><title>Top contributors by DevScore<superscript>(1)</superscript>, authored commits<superscript>(2)</superscript> and lines added/removed<superscript>(3)</superscript></title>
+	<tgroup cols='6' align='left' colsep='1' rowsep='1'>
+	<thead>
+	<row>
+	    <entry align="center"></entry>
+	    <entry align="center">Name</entry>
+	    <entry align="center">DevScore</entry>
+	    <entry align="center">Commits</entry>
+	    <entry align="center">Lines ++</entry>
+	    <entry align="center">Lines --</entry>
+	</row>
+	</thead>
+	<tbody>
+	<row>
+		<entry>1. </entry>
+		<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
+		<entry align="center">27</entry>
+		<entry align="center">1</entry>
+		<entry align="center">3164</entry>
+		<entry align="center">0</entry>
+	</row>
+	</tbody>
+	</tgroup>
+	</table>
+
+	<para>
+	    <emphasis>(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)</emphasis>
+	</para>
+	<para>
+	    <emphasis>(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please <ulink url="https://github.com/OpenSIPS/opensips/pulls"><citetitle>submit a pull request</citetitle></ulink></emphasis> which extends "fix_authors" and/or "mod_renames".
+	</para>
+	<para>
+	    <emphasis>(3) ignoring whitespace edits, renamed files and auto-generated files</emphasis>
+	</para>
+</section>
+
+<section id="contrib_commit_activity" xreflabel="contrib_commit_activity">
+	<title>By Commit Activity</title>
+
+	<table frame='all'><title>Most recently active contributors<superscript>(1)</superscript> to this module</title>
+	<tgroup cols='3' align='left' colsep='1' rowsep='1'>
+	<thead>
+	<row>
+	    <entry align="center"></entry>
+	    <entry align="center">Name</entry>
+	    <entry align="center">Commit Activity</entry>
+	</row>
+	</thead>
+	<tbody>
+	<row>
+		<entry>1. </entry>
+		<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
+		<entry align="center">Mar 2020 - Mar 2020</entry>
+	</row>
+	</tbody>
+	</tgroup>
+	</table>
+
+	<para>
+	    <emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
+	</para>
+</section>
+
+</chapter>
+<chapter id="documentation" xreflabel="documentation">
+	<title>Documentation</title>
+<section id="documentation_contributors" xreflabel="documentation_contributors">
+	<title>Contributors</title>
+	<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>).</para>
+</section>
+
+</chapter>
diff --git a/modules/rate_cacher/doc/rate_cacher.xml b/modules/rate_cacher/doc/rate_cacher.xml
@@ -4,6 +4,7 @@
 
 <!ENTITY admin SYSTEM "rate_cacher_admin.xml">
 <!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
+<!ENTITY contrib SYSTEM "contributors.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
@@ -19,4 +20,5 @@
 
 	&admin;
 	&faq;
+	&contrib;
 </book>