|
1 | 1 | # Contributing guide |
2 | 2 |
|
3 | | -This guide serves as a checklist before contributing to this repository. It mainly focuses on the steps to follow to submit an issue or a pull-request. |
| 3 | +This guide mainly focuses on the steps to follow to submit an issue or a pull request. |
4 | 4 |
|
5 | 5 | ## 1. Issues |
6 | 6 |
|
7 | 7 | ### 1.1 Before opening an issue |
8 | 8 |
|
9 | | -Please check the following points before posting an issue: |
10 | | -* Make sure you are using the latest commit (major releases are tagged, but corrections are available as new commits). |
11 | | -* Make sure your issue is a question/feedback/suggestions **related to** the software provided in this repository. Otherwise, please refer to section [3](CONTRIBUTING.md#3-support-requests-and-questions) below. |
12 | | -* Make sure your issue is not already reported/fixed on GitHub or discussed on a previous issue. Do not forget to browse into the **closed** issues. |
| 9 | +Before posting an issue, please ensure: |
| 10 | +* You are using the latest commit. |
| 11 | +* Your issue is **not** a vulnerability. Otherwise, please refer to section [3](CONTRIBUTING.md#3-vulnerabilities) below. |
| 12 | +* Your issue is **related to** the software provided in this repository. Otherwise, please refer to section [4](CONTRIBUTING.md#4-support-requests-and-miscellaneous) below. |
| 13 | +* Your issue is not already reported, fixed or discussed in a previous one. Remember to browse the **closed** issues. |
13 | 14 |
|
14 | 15 | ### 1.2 Posting the issue |
15 | 16 |
|
16 | | -When you have checked the previous points, create a new report from the **Issues** tab of this repository. A template is available [here](../../issues/new/choose) to help you report the issue you are facing or the enhancement you would like to propose. |
| 17 | +When you have checked the previous points, create a new report from the **Issues** tab of this repository. A couple of templates are available [here](../../issues/new/choose). |
17 | 18 |
|
18 | 19 | ## 2. Pull Requests |
19 | 20 |
|
20 | | -### 2.1 Before opening a pull-request |
| 21 | +### 2.1 Before opening a pull request |
21 | 22 |
|
22 | 23 | STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure. |
23 | 24 |
|
24 | | -* 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). |
25 | | -* 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. |
| 25 | +* 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). |
| 26 | +* 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. |
26 | 27 | * 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. |
27 | 28 |
|
28 | | -Please note that: |
29 | | -* The Corporate CLA will always take precedence over the Individual CLA. |
30 | | -* One CLA submission is sufficient, for any project proposed by STMicroelectronics. |
| 29 | +> [!IMPORTANT] |
| 30 | +> Please note that: |
| 31 | +> * The Corporate CLA will always take precedence over the Individual CLA. |
| 32 | +> * One CLA submission is sufficient, for any project proposed by STMicroelectronics. |
31 | 33 |
|
32 | 34 | ### 2.2 How to proceed |
33 | 35 |
|
34 | 36 | * 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. |
35 | 37 | * Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version. |
36 | | -* Please, submit one pull-request per new feature or proposal. This will ease the analysis and the final merge if accepted. |
| 38 | +* Please, submit one pull request per new feature or proposal. This will ease the analysis and the final merge if accepted. |
37 | 39 |
|
38 | | -## 3. Support requests and questions |
| 40 | +## 3. Vulnerabilities |
39 | 41 |
|
40 | | -For support requests or any other question related to the product, the tools, the environment, you can submit a post to the **ST Community** on the appropriate topic [page](https://community.st.com/s/topiccatalog). |
| 42 | +To report a **vulnerability**, please refer to the [SECURITY.md](./SECURITY.md) file for instructions. |
| 43 | + |
| 44 | +## 4. Support requests and miscellaneous |
| 45 | + |
| 46 | +For support requests or any other topics not related to the content of this repository, you can submit a post to the **ST Community** on the appropriate topic [page](https://community.st.com/s/topiccatalog). |
0 commit comments