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