forked from omapconf/omapconf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCONTRIBUTE
58 lines (44 loc) · 2.42 KB
/
CONTRIBUTE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
###############################################################################
# #
# How to submit OMAPCONF changes #
# #
###############################################################################
Please try to follow the guidelines below. This will make things
easier on the maintainers. Not all of these guidelines matter for every
trivial patch so apply some common sense.
1. Always ###TEST### your changes, however small.
Run provided OMAPCONF non-regression test suites.
2. Make sure your changes compile correctly (0 warning, 0 error).
OMAPCONF follows same coding convention as Linux Kernel.
PLEASE check your patch with the Linux Kernel automated style checker
(scripts/checkpatch.pl) to catch trival style violations.
See Linux Kernel "Documentation/CodingStyle" for guidance.
3. All functions in *.c source files should use the following
doxygen-compliant function header:
/* ------------------------------------------------------------------------*//**
* @FUNCTION function name (only name, not full prototype)
* @BRIEF short description of the function role.
* @RETURNS returned value(s)
* @param[in] for unchanged argument(s)
* @param[in, out] for modified argument(s)
* @DESCRIPTION complete description of the function role.
*//*------------------------------------------------------------------------ */
All created files shall come with he following
doxygen-compliant file header:
/* ======================================================================= *//**
* @Component OMAPCONF
* @Filename name of the file
* @Description main purpose of the functions in this file
* @Author author
* @Date year of creation
* @Copyright person or company owning this code
*//*======================================================================== */
Please keep the same spacing (with tabs) between tags and descriptions
4. Make patch available to [email protected]
PLEASE document known bugs. If it doesn't work for everything
or does something very odd once a month document it.
PLEASE remember that submissions should include a Signed-off-by: line.
5. Make sure you have the right to send any changes you make. If you
do changes at work you may find your employer owns the patch
not you.
Thanks!