Skip to content

Commit 85e6865

Browse files
authored
Update CONTRIBUTING.md
1 parent b6ca2cb commit 85e6865

File tree

1 file changed

+78
-11
lines changed

1 file changed

+78
-11
lines changed

CONTRIBUTING.md

Lines changed: 78 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,81 @@
1-
# Contributing
1+
# Contributing to Eclipse ThreadX
22

3-
This project welcomes contributions and suggestions. Most contributions require you to
4-
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
5-
and actually do, grant us the rights to use your contribution. For details, visit
6-
https://cla.microsoft.com.
3+
Thanks for your interest in this project.
74

8-
When you submit a pull request, a CLA-bot will automatically determine whether you need
9-
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
10-
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
5+
## Project description
116

12-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
13-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
14-
or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
7+
Eclipse ThreadX provides a vendor-neutral, open source, safety certified OS for
8+
real-time applications published on under a permissive license. The Eclipse
9+
ThreadX suite encompasses: ThreadX - advanced real-time operating system (RTOS)
10+
designed specifically for deeply embedded applications NetX Duo - advanced,
11+
industrial-grade TCP/IP network stack designed specifically for deeply embedded
12+
real-time and IoT applications FileX - high-performance, FAT-compatible file
13+
system that’s fully integrated with ThreadX kernel GUIX - provides a complete,
14+
embedded graphical user interface (GUI) library USBX - high-performance USB
15+
host, device, and on-the-go (OTG) embedded stack, that is fully integrated with
16+
ThreadX kernel LevelX - Flash Wear Leveling for FileX and stand-alone purposes
17+
GuiX Studio - design environment, facilitating the creation and maintenance of
18+
all graphical elements for CUIX TraceX - analysis tool that provides a graphical
19+
view of real-time system events to better understand the behavior of real-time
20+
systems
21+
22+
* https://projects.eclipse.org/projects/iot.threadx
23+
24+
## Terms of Use
25+
26+
This repository is subject to the Terms of Use of the Eclipse Foundation
27+
28+
* https://www.eclipse.org/legal/termsofuse.php
29+
30+
## Developer resources
31+
32+
Information regarding source code management, builds, coding standards, and
33+
more.
34+
35+
* https://projects.eclipse.org/projects/iot.threadx/developer
36+
37+
The project maintains the following source code repositories
38+
39+
* https://github.com/eclipse-threadx/.github
40+
* https://github.com/eclipse-threadx/cmsis-packs
41+
* https://github.com/eclipse-threadx/filex
42+
* https://github.com/eclipse-threadx/getting-started
43+
* https://github.com/eclipse-threadx/guix
44+
* https://github.com/eclipse-threadx/levelx
45+
* https://github.com/eclipse-threadx/netxduo
46+
* https://github.com/eclipse-threadx/rtos-docs
47+
* https://github.com/eclipse-threadx/samples
48+
* https://github.com/eclipse-threadx/threadx
49+
* https://github.com/eclipse-threadx/threadx-learn-samples
50+
* https://github.com/eclipse-threadx/tracex
51+
* https://github.com/eclipse-threadx/usbx
52+
53+
## Eclipse Development Process
54+
55+
This Eclipse Foundation open project is governed by the Eclipse Foundation
56+
Development Process and operates under the terms of the Eclipse IP Policy.
57+
58+
* https://eclipse.org/projects/dev_process
59+
* https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf
60+
61+
## Eclipse Contributor Agreement
62+
63+
In order to be able to contribute to Eclipse Foundation projects you must
64+
electronically sign the Eclipse Contributor Agreement (ECA).
65+
66+
* https://www.eclipse.org/legal/ECA.php
67+
68+
The ECA provides the Eclipse Foundation with a permanent record that you agree
69+
that each of your contributions will comply with the commitments documented in
70+
the Developer Certificate of Origin (DCO). Having an ECA on file associated with
71+
the email address matching the "Author" field of your contribution's Git commits
72+
fulfills the DCO's requirement that you sign-off on your contributions.
73+
74+
For more information, please see the Eclipse Committer Handbook:
75+
https://www.eclipse.org/projects/handbook/#resources-commit
76+
77+
## Contact
78+
79+
Contact the project developers via the project's "dev" list.
80+
81+
* https://accounts.eclipse.org/mailing-list/threadx-dev

0 commit comments

Comments
 (0)