Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

CONTRIBUTING.md@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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