Skip to content

Commit 9f1f8ab

Browse files
Create CONTRIBUTING.md
1 parent d40074e commit 9f1f8ab

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# How to Contribute
2+
3+
Network Operator is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub
4+
pull requests. This document outlines some of the conventions on development
5+
workflow, commit message formatting, contact points and other resources to make
6+
it easier to get your contribution accepted.
7+
8+
## Coding Style
9+
10+
Please follows the standard formatting recommendations and language idioms set out
11+
in [Effective Go](https://golang.org/doc/effective_go.html) and in the
12+
[Go Code Review Comments wiki](https://github.com/golang/go/wiki/CodeReviewComments).
13+
14+
## Certificate of Origin
15+
16+
In order to get a clear contribution chain of trust we use the [signed-off-by language](https://01.org/community/signed-process)
17+
used by the Linux kernel project.
18+
19+
DCO can be found [here](https://developercertificate.org/)
20+
21+
## Format of the patch
22+
23+
Beside the signed-off-by footer, we expect each patch to comply with the following format:
24+
25+
```
26+
Change summary
27+
28+
More detailed explanation of your changes: Why and how.
29+
Wrap it to 72 characters.
30+
31+
Signed-off-by: <[email protected]>
32+
```
33+
34+
## Format of PR title and description
35+
36+
Pull Request title and description are expected to conform to [conventional commits specification](https://www.conventionalcommits.org)

0 commit comments

Comments
 (0)