summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAndre Guedes <andre.guedes@intel.com>2018-01-19 10:46:35 -0800
committerAndre Guedes <andre.guedes@intel.com>2018-01-26 18:00:09 -0800
commit196160864d3701a7e84bdf5b006740eed82eb493 (patch)
tree5c77cec2afe38c95ecf544ee5373d1bba3fb045b /lib
parent10dbe2c35f7286003ad2e8926caa710362c58496 (diff)
downloadOpen-AVB-196160864d3701a7e84bdf5b006740eed82eb493.tar.gz
doc: Improve 'Contributing' section
This patch rewrites the 'Contributing' section from HACKING.md file in order to provide information about how to contribute to the project.
Diffstat (limited to 'lib')
-rw-r--r--lib/libavtp/HACKING.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/lib/libavtp/HACKING.md b/lib/libavtp/HACKING.md
index e353bbe3..a5063eee 100644
--- a/lib/libavtp/HACKING.md
+++ b/lib/libavtp/HACKING.md
@@ -1,11 +1,23 @@
# Contributing
-Before submitting your patch to review, make sure it doesn't break any unit
-test. See the following section for information about how to build and run
-the unit tests.
+If you have a bug fixed or added support for some AVTP feature, your patches
+are welcomed! In order to get your patches merged faster, please follow the
+guidelines:
-Additionally, if your patch adds new APIs to libavtp, please also provide
-patches adding test cases that cover the new APIs.
+* Before submitting your patch to review, make sure it doesn't break any unit
+test. See section 'Running Unit Tests' for information about how to build and
+run unit tests.
+
+* Besides the bugfix/feature itself, also provide unit test covering the code
+you're contributing. See section 'Code Coverage' to check how you can easily
+generate coverage reports and see where you need to work on to get your code
+covered.
+
+* If your patch adds new public APIs to libavtp, please also provide patches
+adding example applications (or modify an existing one if it makes sense)
+which demonstrate how to use the new APIs.
+
+* Make sure the author's name and email are set properly.
# Running Unit Tests