Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 2.29 KB
Raw

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. Issues

Before opening 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 your issue is a question/feedback/suggestions **related to** the software provided in this repository. Otherwise, it should be submitted to the ST Community under the MPU topic page.
  • 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.

Posting the issue

When you have checked the previous boxes, create a new issue from the Issues tab of this repository.

2. Pull Requests

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 fork the project in 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 final merge if accepted.

Note

Merge will not be done directly in GitHub but it will need first to follow internal integration process before public deliver in a standard release. The Pull request will stay open until it is merged and delivered.