Contributing guide

This document serves as a checklist before contributing to this repository. 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

In order to centralize your bug reports and requests and to ease their tracking please file an issue into the firmware repository STM32CubeF4.

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 your issue is a question/feedback/suggestions RELATED TO the software provided in this repo. Otherwise, it should be discussed on the ST Community/STM32 MCUs forum.
  • [ ] Make sure your issue is not already reported/fixed on GitHub or discussed on a previous Issue. Please refer to this dashboard for the list of issues and pull-requests. Do not forget to browse into the closed issues.

2. Posting the issue

Once you have checked the previous boxes, you will find two templates for issues (Bug Report or Other Issue) available in the Issues tab of the firmware repository.

3. Pull Requests

For the moment, the Pull Request feature is not deployed. STMicrolectronics is working on a Contributor License Agreement (CLA) procedure.