Diff: mbd_os/features/FEATURE_CLIENT/CONTRIBUTING.md

Revision:

1:55a6170b404f

diff -r b86eda0e990d -r 55a6170b404f mbd_os/features/FEATURE_CLIENT/CONTRIBUTING.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbd_os/features/FEATURE_CLIENT/CONTRIBUTING.md	Sat Sep 17 16:32:05 2016 +0000
@@ -0,0 +1,83 @@
+# How to contribute
+
+This directory structure is entirely generated or copied from another repositories. Do not send patches against it, they cannot be accepted because all code will be entirely overwritten on next release.
+
+Instead follow these instructions to send and test your contributions against master repositories.
+
+## Directory structure
+
+This directory consist of following modules
+
+* [mbed-client](#mbed-client)
+* [mbed-client-c](#mbed-client-c)
+* [mbed-client-mbed-tls](#mbed-client-mbed-tls)
+* [mbed-client-classic](#mbed-client-classic)
+* [mbed-client-randlib](#mbed-client-randlib)
+* [coap-service](#coap-service)
+
+
+## mbed-client
+
+mbed-cient is copied from master repository from here: https://github.com/ARMmbed/mbed-client
+
+To replace the copied version with master repository follow these steps:
+
+* Remove mbed-client directory: `rm -rf mbed-client`
+* Clone from the master: `git clone git@github.com:ARMmbed/mbed-client.git`
+
+Now you have mbed-client directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.
+
+## mbed-client-c
+
+mbed-client-c is copied from master repository from here: https://github.com/ARMmbed/mbed-client-c
+
+To replace the copied version with master repository follow these steps:
+
+* Remove mbed-client-c directory: `rm -rf mbed-client-c`
+* Clone from the master: `git clone git@github.com:ARMmbed/mbed-client-c.git`
+
+Now you have mbed-client-c directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.
+
+## mbed-client-classic
+
+mbed-client-classic is copied from master repository from here: https://github.com/ARMmbed/mbed-client-classic
+
+To replace the copied version with master repository follow these steps:
+
+* Remove mbed-client-classic directory: `rm -rf mbed-client-classic`
+* Clone from the master: `git clone git@github.com:ARMmbed/mbed-client-classic.git`
+
+Now you have mbed-client-classic directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.
+
+## mbed-client-mbed-tls
+
+mbed-client-mbed-tls is copied from master repository from here: https://github.com/ARMmbed/mbed-client-mbed-tls
+
+To replace the copied version with master repository follow these steps:
+
+* Remove mbed-client-mbed-tls directory: `rm -rf mbed-client-mbed-tls`
+* Clone from the master: `git clone git@github.com:ARMmbed/mbed-client-mbed-tls.git`
+
+Now you have mbed-client-mbed-tls directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.
+
+## mbed-client-randlib
+
+mbed-client-randlib is copied from master repository from here: https://github.com/ARMmbed/mbed-client-randlib
+
+To replace the copied version with master repository follow these steps:
+
+* Remove mbed-client-randlib directory: `rm -rf mbed-client-randlib`
+* Clone from the master: `git clone git@github.com:ARMmbed/mbed-client-randlib.git`
+
+Now you have mbed-client-randlib directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.
+
+## coap-service
+
+coap-service is copied from master repository from here: https://github.com/ARMmbed/coap-service
+
+To replace the copied version with master repository follow these steps:
+
+* Remove coap-service directory: `rm -rf coap-service`
+* Clone from the master: `git clone git@github.com:ARMmbed/coap-service.git`
+
+Now you have coap-service directory replaced with Git repository cloned from original. You can build and test your changes against it and send patches normally to Github as a pull requests.