OrgST-Microelectronics
/
STM32CubeF2
mirror of https://github.com/STMicroelectronics/STM32CubeF2.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md with CLA procedure description and mention that pull-requests are now accepted

This commit is contained in:
Ali Labbene 2020-03-26 10:47:18 +01:00
parent 42fc8bf966
commit 495da6902b
4 changed files with 36 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,6 +1,6 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve the quality of our software
title: '' title: ''
labels: '' labels: ''
assignees: '' assignees: ''
@ -9,20 +9,24 @@ assignees: ''
**Caution** **Caution**
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project. The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
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) 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).
**Describe the set-up** **Describe the set-up**
* The board (either ST RPN reference or your custom board) * The board (either ST RPN reference or your custom board).
* IDE or at least the compiler and its version * IDE or at least the compiler and its version.
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**How To Reproduce** **How To Reproduce**
1. Indicate the global behavior of your application project 1. Indicate the global behavior of your application project.
2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...)
3. The use case that generates the problem 2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...).
4. How we can reproduce the problem
3. The use case that generates the problem.
4. How we can reproduce the problem.
**Additional context** **Additional context**
If you have a first analysis or patch correction, thank you to share your proposal. If you have a first analysis or patch correction, thank you to share your proposal.

6
.github/ISSUE_TEMPLATE/other-issue.md vendored
View File

@ -9,11 +9,11 @@ assignees: ''
**Caution** **Caution**
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project. The Issues are strictly limited for the reporting of problem encountered with the software provided in this project.
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) 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).
**Describe the set-up** **Describe the set-up**
* The board (either ST RPN reference or your custom board) * The board (either ST RPN reference or your custom board).
* IDE or at least the compiler and its version * IDE or at least the compiler and its version.
**Additional context** **Additional context**
If you have a first analysis or a patch proposal, thank you to share your proposal. If you have a first analysis or a patch proposal, thank you to share your proposal.

8
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,9 +1,5 @@
## IMPORTANT INFORMATION ## IMPORTANT INFORMATION
### Contributor License Agreement (CLA) ### Contributor License Agreement (CLA)
* The Pull Request will be considered by STMicroelectronics only after a **Contributor License Agreement (CLA)** mechanism is available. * The Pull Request feature will be considered by STMicroelectronics after the signature of a **Contributor License Agreement (CLA)** by the submitter.
* If you did not sign such agreement, please follow the steps mentioned in the [CONTRIBUTING.md](https://github.com/STMicroelectronics/STM32CubeF2/blob/master/CONTRIBUTING.md) file.
* We are currently working on the set-up of this procedure.

25
CONTRIBUTING.md
View File

@ -5,20 +5,29 @@ It includes links to read up on if topics are unclear to you.
This guide mainly focuses on the proper use of Git. This guide mainly focuses on the proper use of Git.
### 1. Before opening an issue ### 1. Before opening an issue
To report a bug/request please file an issue in the right repository To report a bug/request please file an issue in the right repository (example for [STM32CubeF2](https://github.com/STMicroelectronics/STM32CubeF2/issues/new/choose)).
(example for [STM32CubeF2](https://github.com/STMicroelectronics/STM32CubeF2/issues/new/choose)).
But check the following boxes before posting an issue:
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 you are using the latest commit (major releases are Tagged, but corrections are available as new commits).`
- [ ] `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) - [ ] `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).
- [ ] `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 - [ ] `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 ### 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 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.
### 3. Pull Requests ### 3. Pull Requests
For the moment, the Pull Request feature is not deployed. STMicrolectronics is working on a Contributor License Agreement procedure 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 here (https://cla.st.com).
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.
#### 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 for one new feature or proposal. This will ease the analysis and the final merge if accepted.