Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

docs: refresh CONTRIBUTING.md

Browse Source 
Signed-off-by: Alex T <alext.mkrs@gmail.com>
This commit is contained in:
Alex T
2025-10-11 21:00:58 +02:00
committed by Tom Ingleby
parent 31a352a32d
commit d8a04f39c1
1 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@@ -1,7 +1,7 @@
Contributing to Eclipse Mraa (libmraa) {#contributing} 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: with:
- Writing platform supports for all types of boards running linux - 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 Basic rules
----------- -----------
- Your code must build - Your code must build
- Commits must have a sign-off line by at least yourself
- Commits must be named <file/module>: Some decent description - Commits must be named <file/module>: Some decent description
- Try not to break master. In any commit. - Try not to break master. In any commit.
- Try to split commits up logically, you will be asked to rebase them if they - 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 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 also be parsed through the clang-format, it complains but seems to do an ok
job. Few exceptions to coding styles: job. Few exceptions to coding styles:
- All python code is indented by 2 spaces - All Python code is indented by 2 spaces
- CmakeLists files are 2 space indented and a space is required before all - CMakeLists files are 2 space indented and a space is required before all
brackets so endif () and if () and command (). Also use lowercase for brackets so `endif ()` and `if ()` and `command ()`. Also use lowercase for
everything but variables. Cmake is case insensitive but this isn't the wild everything but variables. CMake is case insensitive but this isn't the wild
wild west ;-) wild west ;-)
Use common sense and don't be afraid to challenge something if it doesn't make sense! 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 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 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 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 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 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_: 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. 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). 3. [Log in to the projects forge](https://www.eclipse.org/contribute/cla/) and sign the ["Eclipse ECA"](https://accounts.eclipse.org/user/eca).
4. Ensure that you [_sign-off_](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit) your Git commits.
5. Ensure that you use the _same_ email address as your Eclipse account in commits. 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. 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' Your signing of the ECA will be verified by a Github Check called 'eclipsefdn/eca'
that checks the email address that signed-off on your commits has signed the 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 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 Where to find us
---------------- ----------------
Hop onto the freenode network on IRC and join #mraa. Please be patient as we're Hop onto the freenode network on IRC and join #mraa. Please be patient as we're
not always online. not always online.