diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f85da92..fb8499d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ Contributing to Eclipse Mraa (libmraa) {#contributing} ====================== -Eclipse Mraa is an opensource project and we are actively looking for people to help +Eclipse Mraa is an open source project and we are actively looking for people to help with: - Writing platform supports for all types of boards running linux @@ -16,7 +16,6 @@ issue first so we can avoid disappointments come merging time! Basic rules ----------- - Your code must build -- Commits must have a sign-off line by at least yourself - Commits must be named : Some decent description - Try not to break master. In any commit. - Try to split commits up logically, you will be asked to rebase them if they @@ -28,13 +27,13 @@ Coding Style ------------ Coding style for all code is defined by clang-format, have a look at it. Avoid -styling fixes as they make history difficult to read. Javascript & Java can +styling fixes as they make history difficult to read. JavaScript & Java can also be parsed through the clang-format, it complains but seems to do an ok job. Few exceptions to coding styles: -- All python code is indented by 2 spaces -- CmakeLists files are 2 space indented and a space is required before all - brackets so endif () and if () and command (). Also use lowercase for - everything but variables. Cmake is case insensitive but this isn't the wild +- All Python code is indented by 2 spaces +- CMakeLists files are 2 space indented and a space is required before all + brackets so `endif ()` and `if ()` and `command ()`. Also use lowercase for + everything but variables. CMake is case insensitive but this isn't the wild wild west ;-) Use common sense and don't be afraid to challenge something if it doesn't make sense! @@ -43,7 +42,7 @@ Author Rules ------------ If you create a file, then add yourself as the Author at the top. If you did a -large contribution to it (or if you want to ;-)), then fee free to add yourself +large contribution to it (or if you want to ;-)), then feel free to add yourself to the contributors list in that file. You can also add your own copyright statement to the file but cannot add a license of your own. If you're borrowing code that comes from a project with another license, make sure to explicitly @@ -52,25 +51,23 @@ note this in your PR. Eclipse Contributor Agreement ------------ -Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](http://www.eclipse.org/legal/ECA.php) in place. +Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](https://www.eclipse.org/legal/eca/) in place. Here is the checklist for contributions to be _acceptable_: -1. [Create an account at Eclipse](https://dev.eclipse.org/site_login/createaccount.php). +1. [Create an account at Eclipse](https://accounts.eclipse.org/user/register). 2. Add your GitHub user name in your account settings. -3. [Log into the project's portal](https://projects.eclipse.org/) and sign the ["Eclipse ECA"](https://projects.eclipse.org/user/sign/cla). -4. Ensure that you [_sign-off_](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit) your Git commits. +3. [Log in to the projects forge](https://www.eclipse.org/contribute/cla/) and sign the ["Eclipse ECA"](https://accounts.eclipse.org/user/eca). 5. Ensure that you use the _same_ email address as your Eclipse account in commits. 6. Include the appropriate copyright notice and license at the top of each file. -Your signing of the ECA will be verified by a webservice called 'ip-validation' -that checks the email address that signed-off on your commits has signed the +Your signing of the ECA will be verified by a Github Check called 'eclipsefdn/eca' +that checks the email address that authored your commits has signed the ECA. **Note**: This service is case-sensitive, so ensure the email that signed -the ECA and that signed-off on your commits is the same, down to the case. +the ECA and that authored your commits is the same, down to the case. Where to find us ---------------- Hop onto the freenode network on IRC and join #mraa. Please be patient as we're not always online. -