BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/CONTRIBUTING.md@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

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