Daniel Vizcaya / Mbed OS 04_RTOS_Embebidos

Entrega 3er corte - sistemas embebidos

mbed-os/CONTRIBUTING.md@1:fcdb45ee95b9, 2018-05-30 (annotated)

Committer:
Bethory
Date:
Wed May 30 04:46:28 2018 +0000
Revision:
1:fcdb45ee95b9
Parent:
0:6ad07c9019fd 
Entrega Final

Who changed what in which revision?

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