Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/CONTRIBUTING.md@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
valeyev 0:e056ac8fecf8 1 # Description
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 4
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 6
valeyev 0:e056ac8fecf8 7 ## Where to get more information?
valeyev 0:e056ac8fecf8 8 You can read more on our [documentation page](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/cont/contributing/).
valeyev 0:e056ac8fecf8 9
valeyev 0:e056ac8fecf8 10 # How to contribute
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 12
valeyev 0:e056ac8fecf8 13 Before a pull request will be merged, the [mbed Contributor Agreement](http://developer.mbed.org/contributor_agreement/) must be signed.
valeyev 0:e056ac8fecf8 14
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 16
valeyev 0:e056ac8fecf8 17 # Enhancements vs Bugs
valeyev 0:e056ac8fecf8 18 Enhancements are:
valeyev 0:e056ac8fecf8 19 * New features implementation.
valeyev 0:e056ac8fecf8 20 * Code refactoring.
valeyev 0:e056ac8fecf8 21 * Coding rules, coding styles improvements.
valeyev 0:e056ac8fecf8 22 * Code comments improvement.
valeyev 0:e056ac8fecf8 23 * Documentation work.
valeyev 0:e056ac8fecf8 24
valeyev 0:e056ac8fecf8 25 Bugs are:
valeyev 0:e056ac8fecf8 26 * Issues rose internally or externally by [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) users.
valeyev 0:e056ac8fecf8 27 * Internally (within mbed team) created issues from Continuous Integration pipeline and build servers.
valeyev 0:e056ac8fecf8 28 * Issues detected using automation tools such as compilers, sanitizers, static code analysis tools etc.
valeyev 0:e056ac8fecf8 29
valeyev 0:e056ac8fecf8 30 # Gate Keeper role
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 32
valeyev 0:e056ac8fecf8 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).
valeyev 0:e056ac8fecf8 34
valeyev 0:e056ac8fecf8 35 Please be patient, digest Gate Keeper's feedback and respond promptly :)
valeyev 0:e056ac8fecf8 36
valeyev 0:e056ac8fecf8 37 # mbed SDK porting
valeyev 0:e056ac8fecf8 38 * For more information regarding mbed SDK porting please refer to [mbed SDK porting](http://developer.mbed.org/handbook/mbed-SDK-porting) handbook.
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 40
valeyev 0:e056ac8fecf8 41 # Glossary
valeyev 0:e056ac8fecf8 42 * Gate Keeper – persons responsible for overall code-base quality of [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) project.
valeyev 0:e056ac8fecf8 43 * Enhancement – New feature deployment, code refactoring actions or existing code improvements.
valeyev 0:e056ac8fecf8 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.
valeyev 0:e056ac8fecf8 45 * Mbed classic – mbed SDK 2.0 located in GitHub at [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os).