| ## Contributing guide |
| |
| This document serves as a checklist before contributing to this repository. |
| It includes links to read up on if topics are unclear to you. |
| |
| This guide mainly focuses on steps to be followed to submit an issue or a pull-request. |
| |
| ### 1. Before opening an issue |
| |
| To report a bug or a request please file an issue in the right repository |
| (example for [cmsis_device_wl](https://github.com/STMicroelectronics/cmsis_device_wl/issues/new/choose)). |
| |
| Please check the following boxes before posting an issue: |
| - [ ] `Make sure you are using the latest commit (major releases are tagged, but corrections are available as new commits).` |
| - [ ] `Make sure your issue is a question/feedback/suggestions RELATED TO the software provided in this repository.` Otherwise, it should be submitted to the ST Community under the MCU topic [page](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus). |
| - [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed on a previous issue.` Please refer to this [dashboard](https://github.com/orgs/STMicroelectronics/projects/2) for the list of issues and pull-requests. Do not forget to browse into the **closed** issues. |
| |
| ### 2. Posting the issue |
| |
| When you have checked the previous boxes, create a new report from the **Issues** tab of the repository. A template is available to help you report the issue you are facing or the enhancement you would like to propose. |
| |
| STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure. |
| |
| * If you are an individual writing original source code and you are sure **you own the intellectual property**, then you need to sign an Individual [CLA](https://cla.st.com). |
| * If you work for a company that wants also to allow you to contribute with your work, your company needs to provide a Corporate [CLA](https://cla.st.com) mentioning your GitHub account name. |
| * If you are not sure that a CLA (Individual or Corporate) has been signed for your GitHub account you can check the [CLA](https://cla.st.com) dedicated page. |
| |
| Please note that: |
| * The Corporate CLA will always take precedence over the Individual CLA. |
| * One CLA submission is sufficient, for any project proposed by STMicroelectronics. |
| |
| ### 4. How to proceed |
| |
| * We recommend to engage first a communication thru an issue, in order to present your proposal, just to confirm that it corresponds to STMicroelectronics' domain or scope. |
| * Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version. |
| * Please, submit one pull-request per new feature or proposal. This will ease the analysis and the final merge if accepted. |
