Feng Hong / Mbed OS Nucleo_rtos_basic

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/CONTRIBUTING.md@21:5c6b3657c3cb, 2020-02-22 (annotated)

Committer:
hi1000
Date:
Sat Feb 22 04:53:57 2020 +0000
Revision:
21:5c6b3657c3cb
Parent:
0:765cf978c3e5 
Latest codes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hi1000 0:765cf978c3e5 1 # Description
hi1000 0:765cf978c3e5 2 This document is cheat sheet for everyone who wants to contribute to [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) GitHub repository at GitHub.
hi1000 0:765cf978c3e5 3 All changes in code base should originate from GitHub Issues and take advantage of existing GitHub flows. Goal is to attract contributors and allow them contribute to code and documentation at the same time.
hi1000 0:765cf978c3e5 4
hi1000 0:765cf978c3e5 5 Guidelines from this document are created to help new and existing contributors understand process workflow and align to project rules before pull request is submitted. It explains how a participant should do things like format code, test fixes, and submit patches.
hi1000 0:765cf978c3e5 6
hi1000 0:765cf978c3e5 7 ## Where to get more information?
hi1000 0:765cf978c3e5 8 You can read more on our [documentation page](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/cont/contributing/).
hi1000 0:765cf978c3e5 9
hi1000 0:765cf978c3e5 10 # How to contribute
hi1000 0:765cf978c3e5 11 We really appreciate your contributions! We are Open Source project and we need your help. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
hi1000 0:765cf978c3e5 12
hi1000 0:765cf978c3e5 13 Before a pull request will be merged, the [mbed Contributor Agreement](http://developer.mbed.org/contributor_agreement/) must be signed.
hi1000 0:765cf978c3e5 14
hi1000 0:765cf978c3e5 15 You can pick up existing [mbed-os GitHub Issue](https://github.com/ARMmbed/mbed-os/issues) and solve it or implement new feature you find important, attractive or just necessary. We will review your proposal via pull request mechanism, give you comments and merge your changes if we decide your contribution satisfy criteria such as quality.
hi1000 0:765cf978c3e5 16
hi1000 0:765cf978c3e5 17 # Enhancements vs Bugs
hi1000 0:765cf978c3e5 18 Enhancements are:
hi1000 0:765cf978c3e5 19 * New features implementation.
hi1000 0:765cf978c3e5 20 * Code refactoring.
hi1000 0:765cf978c3e5 21 * Coding rules, coding styles improvements.
hi1000 0:765cf978c3e5 22 * Code comments improvement.
hi1000 0:765cf978c3e5 23 * Documentation work.
hi1000 0:765cf978c3e5 24
hi1000 0:765cf978c3e5 25 Bugs are:
hi1000 0:765cf978c3e5 26 * Issues rose internally or externally by [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) users.
hi1000 0:765cf978c3e5 27 * Internally (within mbed team) created issues from Continuous Integration pipeline and build servers.
hi1000 0:765cf978c3e5 28 * Issues detected using automation tools such as compilers, sanitizers, static code analysis tools etc.
hi1000 0:765cf978c3e5 29
hi1000 0:765cf978c3e5 30 # Gate Keeper role
hi1000 0:765cf978c3e5 31 Gate Keeper is a person responsible for GitHub process workflow execution and is responsible for repository / project code base. Gate Keeper is also responsible for code (pull request) quality stamp and approves or rejects code changes in project’s code base.
hi1000 0:765cf978c3e5 32
hi1000 0:765cf978c3e5 33 Gate Keepers will review your pull request code, give you comments in pull request comment section and in the end if everything goes well merge your pull request to one of our branches (most probably default ```master``` branch).
hi1000 0:765cf978c3e5 34
hi1000 0:765cf978c3e5 35 Please be patient, digest Gate Keeper's feedback and respond promptly :)
hi1000 0:765cf978c3e5 36
hi1000 0:765cf978c3e5 37 # mbed SDK porting
hi1000 0:765cf978c3e5 38 * For more information regarding mbed SDK porting please refer to [mbed SDK porting](http://developer.mbed.org/handbook/mbed-SDK-porting) handbook.
hi1000 0:765cf978c3e5 39 * Before starting the mbed SDK porting, you might want to familiarize with the [mbed SDK library internals](http://developer.mbed.org/handbook/mbed-library-internals) first.
hi1000 0:765cf978c3e5 40
hi1000 0:765cf978c3e5 41 # Glossary
hi1000 0:765cf978c3e5 42 * Gate Keeper – persons responsible for overall code-base quality of [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) project.
hi1000 0:765cf978c3e5 43 * Enhancement – New feature deployment, code refactoring actions or existing code improvements.
hi1000 0:765cf978c3e5 44 * Bugfix – Issues originated from GitHub Issues pool, raised internally within mbed classic team or issues from automated code validators like linters, static code analysis tools etc.
hi1000 0:765cf978c3e5 45 * Mbed classic – mbed SDK 2.0 located in GitHub at [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os).