Skip to content

Commit d8a04f3

Browse files
alext-mkrstingleby
authored andcommitted
docs: refresh CONTRIBUTING.md
Signed-off-by: Alex T <alext.mkrs@gmail.com>
1 parent 31a352a commit d8a04f3

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Contributing to Eclipse Mraa (libmraa) {#contributing}
22
======================
33

4-
Eclipse Mraa is an opensource project and we are actively looking for people to help
4+
Eclipse Mraa is an open source project and we are actively looking for people to help
55
with:
66

77
- Writing platform supports for all types of boards running linux
@@ -16,7 +16,6 @@ issue first so we can avoid disappointments come merging time!
1616
Basic rules
1717
-----------
1818
- Your code must build
19-
- Commits must have a sign-off line by at least yourself
2019
- Commits must be named <file/module>: Some decent description
2120
- Try not to break master. In any commit.
2221
- Try to split commits up logically, you will be asked to rebase them if they
@@ -28,13 +27,13 @@ Coding Style
2827
------------
2928

3029
Coding style for all code is defined by clang-format, have a look at it. Avoid
31-
styling fixes as they make history difficult to read. Javascript & Java can
30+
styling fixes as they make history difficult to read. JavaScript & Java can
3231
also be parsed through the clang-format, it complains but seems to do an ok
3332
job. Few exceptions to coding styles:
34-
- All python code is indented by 2 spaces
35-
- CmakeLists files are 2 space indented and a space is required before all
36-
brackets so endif () and if () and command (). Also use lowercase for
37-
everything but variables. Cmake is case insensitive but this isn't the wild
33+
- All Python code is indented by 2 spaces
34+
- CMakeLists files are 2 space indented and a space is required before all
35+
brackets so `endif ()` and `if ()` and `command ()`. Also use lowercase for
36+
everything but variables. CMake is case insensitive but this isn't the wild
3837
wild west ;-)
3938

4039
Use common sense and don't be afraid to challenge something if it doesn't make sense!
@@ -43,7 +42,7 @@ Author Rules
4342
------------
4443

4544
If you create a file, then add yourself as the Author at the top. If you did a
46-
large contribution to it (or if you want to ;-)), then fee free to add yourself
45+
large contribution to it (or if you want to ;-)), then feel free to add yourself
4746
to the contributors list in that file. You can also add your own copyright
4847
statement to the file but cannot add a license of your own. If you're borrowing
4948
code that comes from a project with another license, make sure to explicitly
@@ -52,25 +51,23 @@ note this in your PR.
5251
Eclipse Contributor Agreement
5352
------------
5453

55-
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](http://www.eclipse.org/legal/ECA.php) in place.
54+
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](https://www.eclipse.org/legal/eca/) in place.
5655

5756
Here is the checklist for contributions to be _acceptable_:
5857

59-
1. [Create an account at Eclipse](https://dev.eclipse.org/site_login/createaccount.php).
58+
1. [Create an account at Eclipse](https://accounts.eclipse.org/user/register).
6059
2. Add your GitHub user name in your account settings.
61-
3. [Log into the project's portal](https://projects.eclipse.org/) and sign the ["Eclipse ECA"](https://projects.eclipse.org/user/sign/cla).
62-
4. Ensure that you [_sign-off_](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit) your Git commits.
60+
3. [Log in to the projects forge](https://www.eclipse.org/contribute/cla/) and sign the ["Eclipse ECA"](https://accounts.eclipse.org/user/eca).
6361
5. Ensure that you use the _same_ email address as your Eclipse account in commits.
6462
6. Include the appropriate copyright notice and license at the top of each file.
6563

66-
Your signing of the ECA will be verified by a webservice called 'ip-validation'
67-
that checks the email address that signed-off on your commits has signed the
64+
Your signing of the ECA will be verified by a Github Check called 'eclipsefdn/eca'
65+
that checks the email address that authored your commits has signed the
6866
ECA. **Note**: This service is case-sensitive, so ensure the email that signed
69-
the ECA and that signed-off on your commits is the same, down to the case.
67+
the ECA and that authored your commits is the same, down to the case.
7068

7169
Where to find us
7270
----------------
7371

7472
Hop onto the freenode network on IRC and join #mraa. Please be patient as we're
7573
not always online.
76-

0 commit comments

Comments
 (0)