-
Notifications
You must be signed in to change notification settings - Fork 33
/
CONTRIBUTING.txt
73 lines (55 loc) · 2.84 KB
/
CONTRIBUTING.txt
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
Reliance Edge Contribution Guidelines
=====================================
This document describes how to go about contributing to Reliance Edge.
How Can I Contribute?
---------------------
A few examples of how you can contribute:
- Fixing bugs, including: compiler warnings, portability issues, or erroneous
driver logic.
- Porting Reliance Edge to a new RTOS.
- Improving the documentation, including: fixing typos, dead links, or poor
wording; or pointing out unclear or incomplete instructions.
- Creating new tools or tests.
- Adding new features or APIs (though for major new features, it might be good
to discuss your idea with Tuxera).
Suggestions and feedback of any kind are welcome at <support@tuxera.com>. If
there is something about Reliance Edge which you like or do not like, let us
know.
Reporting Bugs
--------------
To report bugs, please create a GitHub issue or contact <support@tuxera.com>.
Search the existing GitHub issues to make sure that your issue is not a known
issue.
Submitting Changes
------------------
To submit code changes, fork the Reliance Edge repository, commit your changes,
and use GitHub to submit a pull request. See details here:
<https://help.github.com/articles/using-pull-requests/>
After submitting a pull request, it will be reviewed by Tuxera engineers. You
may be asked to make changes via the comments on the pull request. If the pull
request contributes a substantial amount of code, you will need to assign
copyright to Tuxera US Inc before it will be accepted (see the next section).
For the portions of the _Developer's Guide_ that are included in the GitHub
repository (like the API documentation, which is derived from Doxygen comments
in the code), changes should be submitted as pull requests just like code. For
the prose chapters which are excluded from the repository, send an email to
<support@tuxera.com> to request changes.
Copyright
---------
Tuxera policy is that Tuxera US Inc must own the copyright of all code
incorporated into Reliance Edge; if contributing a substantial amount of code,
you must file a copyright assignment agreement. After submitting your pull
request, contact <support@tuxera.com> if you believe you will need to assign the
copyright. If Tuxera determines that a copyright assignment agreement is
required, and you have not made contact, you will be notified via a comment left
on the pull request.
CREDITS.TXT
-----------
CREDITS.TXT is a list of people who have made non-trivial contributions to
Reliance Edge. If you contribute to Reliance Edge, it is understood that
Tuxera may, at our discretion, add your name and GitHub account name to
CREDITS.TXT, unless you explicitly request to be excluded.
Reliance Edge Coding Style
--------------------------
Code contributed to Reliance Edge should make an attempt to follow its coding
style. See the doc/coding_style.txt document.