tmk_core/tool/mbed/mbed-sdk/CONTRIBUTING.md

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