blob: 7dad9d0e7d59db515ee74fb1f059b5c57fe848de [file] [log] [blame] [view]
## 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 the proper use of Git.
### 1. Before opening an issue
To report a bug/request please file an issue in the right repository
(example for [cmsis_device_l0](https://github.com/STMicroelectronics/cmsis_device_l0/issues/new/choose)).
But 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 repo.` Otherwise, it should be discussed on the [ST Community/STM32 MCUs forum](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. You will find two templates Issues (Bug Report or Other Issue) available in the **Issues** tab of the repo
### 3. Pull Requests
For the moment, the Pull Request feature is not deployed. STMicrolectronics is working on a Contributor License Agreement procedure