Skip to content

Commit 4cc431a

Browse files
committed
readme: Add a how to contribute chapter
Waiting the wiki, add a chapter to inform how to contribute. this chapter is inspired from zephyr documentation. Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@st.com>
1 parent 95bfbb9 commit 4cc431a

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,47 @@ For now, it supports:
258258
2. `sudo` is required to run the OpenAMP demos between Linux processes, as
259259
it doesn't work on some systems if you are normal users.
260260
261+
## How to contribute:
262+
As an open-source project, we welcome and encourage the community to submit patches directly to the project. As a contributor you should be familiar with common developer tools such as Git and CMake, and platforms such as GitHub.
263+
Then following points should be rescpected to facilitate the review process.
264+
265+
### Licencing
266+
Code is contributed to the Linux kernel under a number of licenses, but all code must be compatible with version the [BSD License](https://github.com/OpenAMP/open-amp/blob/master/LICENSE.md), which is the license covering the OpenAMP distribution as a whole. In practice, use the following tag instead of the full license text in the individual files:
267+
268+
```
269+
SPDX-License-Identifier: BSD-3-Clause
270+
SPDX-License-Identifier: BSD-2-Clause
271+
```
272+
### Signed-off-by
273+
Commit message must contain Signed-off-by: line and your email must match the change authorship information. Make sure your .gitconfig is set up correctly:
274+
275+
```
276+
git config --global user.name "first-name Last-Namer"
277+
git config --global user.email "yourmail@company.com"
278+
```
279+
### gitlint
280+
Before you submit a pull request to the project, verify your commit messages meet the requirements. The check can be performed locally using the the gitlint command.
281+
282+
Run gitlint locally in your tree and branch where your patches have been committed:
283+
284+
```gitlint```
285+
Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or use the --commits option to specify a commit range covering all the development patches to be submitted.
286+
287+
### Code style
288+
In general, follow the Linux kernel coding style, with the following exceptions:
289+
290+
* Use /** */ for doxygen comments that need to appear in the documentation.
291+
292+
The Linux kernel GPL-licensed tool checkpatch is used to check coding style conformity.Checkpatch is available in the scripts directory.
293+
294+
To check your \<n\> commits in your git branch:
295+
```
296+
./scripts/checkpatch.pl --strict -g HEAD-<n>
297+
298+
```
299+
### Send a pull request
300+
We use standard github mechanism for pull request. Please refer to github documentation for help.
301+
261302
## Communication and Collaboration
262303
[Subscribe](https://lists.openampproject.org/mailman/listinfo/openamp-rp) to the OpenAMP mailing list(openamp-rp@lists.openampproject.org).
263304

0 commit comments

Comments
 (0)