Skip to content

Commit b4f64c7

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 b81bd5c commit b4f64c7

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,3 +244,43 @@ libmetal sleep APIs provide getting delay execution implementation.
244244
This API is for compiler dependent functions. For this release, there is only
245245
a GCC implementation, and compiler specific code is limited to atomic
246246
operations.
247+
248+
## How to contribute:
249+
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.
250+
Then following points should be rescpected to facilitate the review process.
251+
252+
### Licencing
253+
Code is contributed to OpenAMP under a number of licenses, but all code must be compatible with version the [BSD License](https://github.com/OpenAMP/libmetal/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:
254+
255+
```
256+
SPDX-License-Identifier: BSD-3-Clause
257+
```
258+
### Signed-off-by
259+
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:
260+
261+
```
262+
git config --global user.name "first-name Last-Namer"
263+
git config --global user.email "yourmail@company.com"
264+
```
265+
### gitlint
266+
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.
267+
268+
Run gitlint locally in your tree and branch where your patches have been committed:
269+
270+
```gitlint```
271+
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.
272+
273+
### Code style
274+
In general, follow the Linux kernel coding style, with the following exceptions:
275+
276+
* Use /** */ for doxygen comments that need to appear in the documentation.
277+
278+
The Linux kernel GPL-licensed tool checkpatch is used to check coding style conformity.Checkpatch is available in the scripts directory.
279+
280+
To check your \<n\> commits in your git branch:
281+
```
282+
./scripts/checkpatch.pl --strict -g HEAD-<n>
283+
284+
```
285+
### Send a pull request
286+
We use standard github mechanism for pull request. Please refer to github documentation for help.

0 commit comments

Comments
 (0)