Skip to content

Commit 9121ab8

Browse files
committed
[DOC] Update CONTRIBUTING.md
1 parent 9220330 commit 9121ab8

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
1-
## Contributing guide
2-
This document serves as a checklist before contributing to this repository.
3-
It includes links to read up on if topics are unclear to you.
1+
# Contributing guide
42

5-
This guide mainly focuses on the proper use of Git.
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.
64

7-
### 1. Before opening an issue
8-
To report a bug/request please file an issue in the right repository (example for [STM32CubeL4](https://github.com/STMicroelectronics/STM32CubeL4/issues/new/choose)).
5+
## 1. Issues
96

10-
Please check the following boxes before posting an issue:
11-
- [ ] `Make sure you are using the latest commit (major releases are Tagged, but corrections are available as new commits).`
12-
- [ ] `Make sure your issue is a question/feedback/suggestions RELATED TO the software provided in this repository.` Otherwise, it should be discussed on the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus).
13-
- [ ] `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.
7+
### 1.1 Before opening an issue
148

15-
### 2. Posting the issue
16-
When you have checked the previous boxes. You will find two templates (Bug Report or Other Issue) available in the **Issues** tab of the repository.
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.
13+
14+
### 1.2 Posting the issue
15+
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+
18+
## 2. Pull Requests
19+
20+
### 2.1 Before opening a pull-request
1721

18-
### 3. Pull Requests
1922
STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure.
2023

21-
* 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).
22-
* 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.
23-
* If you are not sure that a CLA (Individual or Corporate) has been signed for your GitHub account you can check here (https://cla.st.com).
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.
26+
* 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.
2427

2528
Please note that:
2629
* The Corporate CLA will always take precedence over the Individual CLA.
2730
* One CLA submission is sufficient, for any project proposed by STMicroelectronics.
2831

29-
#### How to proceed
32+
### 2.2 How to proceed
3033

31-
* 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.
34+
* 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.
3235
* Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version.
33-
* Please, submit one Pull Request for one new feature or proposal. This will ease the analysis and the final merge if accepted.
36+
* Please, submit one pull-request per new feature or proposal. This will ease the analysis and the final merge if accepted.
37+
38+
## 3. Support requests and questions
39+
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).

0 commit comments

Comments
 (0)