From 430bbe6904ae646f134f72b12f317f8fe01aecc9 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Thu, 26 Mar 2020 10:06:16 +0100 Subject: [PATCH] Update CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md with CLA procedure description and mention that pull-requests are now accepted --- .github/ISSUE_TEMPLATE/bug_report.md | 16 ++++++++-------- .github/ISSUE_TEMPLATE/other-issue.md | 6 +++--- .github/PULL_REQUEST_TEMPLATE.md | 9 +++------ CONTRIBUTING.md | 27 ++++++++++++++++++--------- README.md | 4 ++++ Release_Notes.html | 6 ++++-- 6 files changed, 40 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f76fec1d..48611fd7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- 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: '' labels: '' assignees: '' @@ -9,23 +9,23 @@ assignees: '' **Caution** 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** - * The board (either ST RPN reference or your custom board) - * IDE or at least the compiler and its version + * The board (either ST RPN reference or your custom board). + * IDE or at least the compiler and its version. **Describe the bug** A clear and concise description of what the bug is. **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 ...) +2. The modules that you suspect to be the cause of the problem (Driver, BSP, MW ...). -3. The use case that generates the problem +3. The use case that generates the problem. -4. How we can reproduce the problem +4. How we can reproduce the problem. **Additional context** diff --git a/.github/ISSUE_TEMPLATE/other-issue.md b/.github/ISSUE_TEMPLATE/other-issue.md index 51648617..d72cf58b 100644 --- a/.github/ISSUE_TEMPLATE/other-issue.md +++ b/.github/ISSUE_TEMPLATE/other-issue.md @@ -9,11 +9,11 @@ assignees: '' **Caution** 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** - * The board (either ST RPN reference or your custom board) - * IDE or at least the compiler and its version + * The board (either ST RPN reference or your custom board). + * IDE or at least the compiler and its version. **Additional context** If you have a first analysis or a patch proposal, thank you to share your proposal. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 721da064..d859cd03 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,5 @@ -## IMPORTANT INFORMATION +## IMPORTANT INFORMATION ### Contributor License Agreement (CLA) -* The Pull Request feature will be considered by STMicroelectronics only after a **Contributor License Agreement (CLA)** mechanism has been deployed. -* We are currently working on the set-up of this procedure. - - - +* 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/STM32CubeF0/blob/master/CONTRIBUTING.md) file. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bffe8cca..a8314a3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. ### 1. Before opening an issue -To report a bug/request please file an issue in the right repository -(example for [STM32CubeF0](https://github.com/STMicroelectronics/STM32CubeF0/issues/new/choose)). -But check the following boxes before posting an issue: +To report a bug/request please file an issue in the right repository (example for [STM32CubeF0](https://github.com/STMicroelectronics/STM32CubeF0/issues/new/choose)). +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).` -- [ ] `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 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 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.` 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 +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 -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). - \ No newline at end of file +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. diff --git a/README.md b/README.md index e6fd3869..f158e530 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ Please take a look to the Release Note document to get detailed information on t In this FW Package, the module **Middlewares/ST/STemWin** is not directly accessible. It must be downloaded from a ST server. The URL is available in a readme.txt file inside the module. +## Release note + +Details about the content of this release are available in the release note [here](https://htmlpreview.github.io/?https://github.com/STMicroelectronics/STM32CubeF0/blob/master/Release_Notes.html). + ## Boards available * STM32F0 * [32F0308DISCOVERY](https://www.st.com/en/evaluation-tools/32f0308discovery.html) diff --git a/Release_Notes.html b/Release_Notes.html index d0345d9e..4b9e04a9 100644 --- a/Release_Notes.html +++ b/Release_Notes.html @@ -444,7 +444,7 @@
- +

Maintenance release

Main Changes

@@ -1076,6 +1076,8 @@
  • None
    • +
    +

    Maintenance release

    @@ -1721,7 +1723,7 @@
    - +

    Maintenance release

    Main Changes