Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

CONTRIBUTING.md@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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