Skip to content

Commit 0f7bb3e

Browse files
Peter Oberparleiteroberpar
authored andcommitted
lcov: Added contribution guidelines
1 parent f83688f commit 0f7bb3e

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

CONTRIBUTING

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
Contributing to LCOV
2+
====================
3+
4+
Please read this document if you would like to help improving the LTP GCOV
5+
extension (LCOV). In general, all types of contributions are welcome, for
6+
example:
7+
8+
* Fixes for code or documentation
9+
* Performance and compatibility improvements
10+
* Functional enhancements
11+
12+
There are some rules that these contributions must follow to be acceptable for
13+
inclusion:
14+
15+
1. The contribution must align with the project goals of LCOV.
16+
2. The contribution must follow a particular format.
17+
3. The contribution must be signed.
18+
19+
Once you have made sure that your contribution follows these rules, send it via
20+
e-mail to the LTP coverage mailing list [1].
21+
22+
23+
Signing your work
24+
=================
25+
26+
All contributions to LCOV must be signed by putting the following line at the
27+
end of the explanation of a patch:
28+
29+
Signed-off-by: Your Name <[email protected]>
30+
31+
By signing a patch, you certify the following:
32+
33+
By making a contribution to the LTP GCOV extension (LCOV) on
34+
http://ltp.sourceforge.net, I certify that:
35+
36+
a) The contribution was created by me and I have the right to submit it
37+
under the terms and conditions of the open source license
38+
"GNU General Public License, version 2 or later".
39+
(http://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
40+
41+
b) The contribution is made free of any other party's intellectual property
42+
claims or rights.
43+
44+
c) I understand and agree that this project and the contribution are public
45+
and that a record of the contribution (including all personal information
46+
I submit with it, including my sign-off) is maintained indefinitely and
47+
may be redistributed consistent with this project or the open source
48+
license(s) involved.
49+
50+
51+
Project goals
52+
=============
53+
54+
The goal of LCOV is to provide a set of command line tools that can be used to
55+
collect, process and visualize code coverage data as produced by the gcov tool
56+
that is part of the GNU Compiler Collection (GCC) [2].
57+
58+
If you have an idea for a contribution but are unsure if it aligns with the
59+
project goals, feel free to discuss the idea on the LTP coverage mailing
60+
list [1].
61+
62+
63+
Contribution format
64+
===================
65+
66+
To contribute a change, please create a patch using the diff utility with the
67+
following command line options:
68+
69+
diff -Naurp
70+
71+
Please base your changes on the most current version of LCOV. You can use the
72+
following command line to obtain this version from the "utils" module of the
73+
LTP CVS repository (when asked for a password, simply press return):
74+
75+
cvs -d:pserver:[email protected]:/cvsroot/ltp login
76+
cvs -z3 -d:pserver:[email protected]:/cvsroot/ltp co -P utils
77+
78+
You can find LCOV in sub-directory "utils/analysis/lcov".
79+
80+
Add a meaningful description of the contribution to the top of the patch. The
81+
description should follow this format:
82+
83+
component: short description
84+
85+
detailed description
86+
87+
Signed-off-by: Your Name <[email protected]>
88+
89+
With your Signed-off-by, you certify the rules stated in section
90+
"Signing your work".
91+
92+
93+
--
94+
95+
96+
[2] http://gcc.gnu.org

0 commit comments

Comments
 (0)