Skip to content

Commit 08376dc

Browse files
committed
Update CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md with CLA procedure description and mention that pull-requests are now accepted
1 parent 79acbf8 commit 08376dc

File tree

4 files changed

+32
-26
lines changed

4 files changed

+32
-26
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Create a report to help us improve the quality of our software
44
title: ''
55
labels: ''
66
assignees: ''
@@ -9,23 +9,23 @@ assignees: ''
99

1010
**Caution**
1111
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
12-
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus)
12+
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus).
1313

1414
**Describe the set-up**
15-
* The board (either ST RPN reference or your custom board)
16-
* IDE or at least the compiler and its version
15+
* The board (either ST RPN reference or your custom board).
16+
* IDE or at least the compiler and its version.
1717

1818
**Describe the bug**
1919
A clear and concise description of what the bug is.
2020

2121
**How To Reproduce**
22-
1. Indicate the global behavior of your application project
22+
1. Indicate the global behavior of your application project.
2323

24-
2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...)
24+
2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...).
2525

26-
3. The use case that generates the problem
26+
3. The use case that generates the problem.
2727

28-
4. How we can reproduce the problem
28+
4. How we can reproduce the problem.
2929

3030

3131
**Additional context**

.github/ISSUE_TEMPLATE/other-issue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ assignees: ''
99

1010
**Caution**
1111
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
12-
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus)
12+
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post a topic in the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus).
1313

1414
**Describe the set-up**
15-
* The board (either ST RPN reference or your custom board)
16-
* IDE or at least the compiler and its version
15+
* The board (either ST RPN reference or your custom board).
16+
* IDE or at least the compiler and its version.
1717

1818
**Additional context**
1919
If you have a first analysis or a patch proposal, thank you to share your proposal.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
## IMPORTANT INFORMATION
1+
## IMPORTANT INFORMATION
22

33
### Contributor License Agreement (CLA)
4-
* The Pull Request feature will be considered by STMicroelectronics only after a **Contributor License Agreement (CLA)** mechanism has been deployed.
5-
* We are currently working on the set-up of this procedure.
6-
7-
8-
4+
* The Pull Request feature will be considered by STMicroelectronics after the signature of a **Contributor License Agreement (CLA)** by the submitter.
5+
* If you did not sign such agreement, please follow the steps mentioned in the [CONTRIBUTING.md](https://github.com/STMicroelectronics/STM32CubeF7/blob/master/CONTRIBUTING.md) file.

CONTRIBUTING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,29 @@ It includes links to read up on if topics are unclear to you.
55
This guide mainly focuses on the proper use of Git.
66

77
### 1. Before opening an issue
8-
To report a bug/request please file an issue in the right repository
9-
(example for [STM32CubeF7](https://github.com/STMicroelectronics/STM32CubeF7/issues/new/choose)).
10-
But check the following boxes before posting an issue:
8+
To report a bug/request please file an issue in the right repository (example for [STM32CubeF7](https://github.com/STMicroelectronics/STM32CubeF7/issues/new/choose)).
119

10+
Please check the following boxes before posting an issue:
1211
- [ ] `Make sure you are using the latest commit (major releases are Tagged, but corrections are available as new commits).`
13-
- [ ] `Your issue is NOT a question/feedback/suggestions related to the software provided in this repo.` This should be discussed on the [ST Community/STM32 MCUs forum](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus)
14-
- [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed on a previous Issue.` Don't forget to browse into the **Closed** Issues
15-
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.
1614

1715
### 2. Posting the issue
18-
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
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.
1917

2018
### 3. Pull Requests
21-
For the moment, the Pull Request feature is not deployed. STMicrolectronics is working on a Contributor License Agreement procedure
19+
STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure.
20+
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+
25+
Please note that:
26+
* The Corporate CLA will always take precedence over the Individual CLA.
27+
* One CLA submission is sufficient, for any project proposed by STMicroelectronics.
2228

29+
#### How to proceed
2330

24-
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.
32+
* 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.

0 commit comments

Comments
 (0)