|
1 | 1 |
|
2 | | - ## Forum: |
3 | | - https://www.stm32duino.com |
| 2 | + # Welcome to the STM32duino open source community |
| 3 | + |
| 4 | +> [!NOTE] |
| 5 | +> STM32duino GitHub organization is an open source community, it is not part of the official software ecosystem supported by ST. |
| 6 | +> Nevertheless ST contributes to this community. |
| 7 | +
|
| 8 | +This organization hosts the various open-source projects managed by the stm32duino team, including: |
| 9 | + |
| 10 | +* [STM32 Core](https://github.com/stm32duino/Arduino_Core_STM32) |
| 11 | +* [upload tools](https://github.com/stm32duino/Arduino_Tools) for STM32 based boards and some other usefull scripts. |
| 12 | +* libraries: |
| 13 | + * STM32 features: |
| 14 | + * [BLE](/../../../STM32duinoBLE) |
| 15 | + * [Ethernet](/../../../STM32Ethernet) |
| 16 | + * [LoRaWAN](/../../../STM32LoRaWAN) |
| 17 | + * [LowPower](/../../../STM32LowPower) |
| 18 | + * [RTC](/../../../STM32RTC) |
| 19 | + * [SD](/../../../STM32SD) |
| 20 | + * [Sensors](https://github.com/orgs/stm32duino/repositories?q=sensor+NOT+X-Nucleo) |
| 21 | + * [X-Nucleo](https://github.com/orgs/stm32duino/repositories?q=X-Nucleo) |
| 22 | + * Third party: |
| 23 | + * [FatFs](/../../../FatFs) |
| 24 | + * [FreeRTOS](/../../../STM32FreeRTOS) |
| 25 | + * [LwIP](/../../../LwIP) |
| 26 | +* and some [others](https://github.com/orgs/stm32duino/repositories)... |
| 27 | + |
| 28 | +> [!IMPORTANT] |
| 29 | +> For question, support, ..., you could submit a topic on the [stm32duino forum] or open a [discussions]. |
| 30 | +> |
| 31 | +> If you have any issue, you could file an issue on one of the repository of the stm32duino GitHub organization. |
| 32 | +
|
| 33 | +## :sparkles: How you can contribute |
| 34 | + |
| 35 | +**Any contribution are welcome and very appreciated.** |
| 36 | + |
| 37 | +* __Triage__ open issues: try to reproduce issues reported by other users and confirm whether you can experience them as well, or ask users for more details if needed. Spot duplicates. Improve descriptions. Help users who ask for support. |
| 38 | +* __Submit__ fixes and implementations: pick an open issue or feature request that you think you can implement yourself, and submit a pull request following the [contributing](/CONTRIBUTING.md) guidelines. |
| 39 | +* __Review__ and comment on the changes proposed in open pull requests suggesting good ways to implement fixes and features. |
| 40 | +* __Test__ open pull requests: try to run the proposed modifications and report your success or failure. Testing on real hardware takes time and any help in this will speed up our responsiveness in merging contributions. |
| 41 | +* __Help others__ by answering to GitHub [discussions] or topics in the dedicated [stm32duino forum] |
| 42 | +* __Write documentation__ and improve the existing content. Including the [WiKi] |
| 43 | + |
| 44 | +> [!IMPORTANT] |
| 45 | +> We are looking for new contributor/maintainer to help on above topics. If you are interested to join the stm32duino team to contribute to one or more repositories, |
| 46 | +> let us know by commenting this [discussion](https://github.com/orgs/stm32duino/discussions/2555). |
| 47 | +
|
| 48 | + |
| 49 | +## :lock: Security |
| 50 | +To report potential vulnerabilities, please see our [security](/SECURITY.md) policy. |
4 | 51 |
|
5 | | - ## WiKi: |
6 | | - https://github.com/stm32duino/Arduino_Core_STM32/wiki |
7 | 52 |
|
8 | | -More to come... |
| 53 | +[discussions]: https://github.com/orgs/stm32duino/discussions |
| 54 | +[stm32duino forum]: https://www.stm32duino.com |
| 55 | +[WiKi]: https://github.com/stm32duino/Arduino_Core_STM32/wiki |
9 | 56 |
|
10 | 57 | <!-- |
11 | 58 |
|
|
0 commit comments