File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contirbution Guidelines
2+
3+ netlink accepts contributions via GitHub pull requests. This document outlines some of the conventions on how to contribute
4+ code to the project
5+
6+ ## General
7+
8+ * One commit per PR.
9+ * A PR covers a single area/functionality (e.g extension of devlink command and link command should go in separate PRs )
10+ * Each PR should be covered by unit tests when applicable.
11+ * The goal of Netlink package is to follow iproute2 behavior. when in doubt refer to iproute2 [ source code] ( https://github.com/iproute2/iproute2 ) .
12+
13+ ## Code Style
14+
15+ Please follows the standard formatting recommendations and language idioms set out in [ Effective Go] ( https://golang.org/doc/effective_go.html )
16+ and in the [ Go Code Review Comments wiki] ( https://github.com/golang/go/wiki/CodeReviewComments ) .
17+
18+ ## Commit Message Style
19+
20+ Each commit is expected to comply with the following format:
21+
22+ ```
23+ Change summary
24+
25+ More detailed explanation of your changes: Why and how.
26+ Wrap it to 72 characters.
27+ See [here] (http://chris.beams.io/posts/git-commit/)
28+ for some more good advices.
29+ ```
30+
31+ For example:
32+
33+ ```
34+ Fix poorly named identifiers
35+
36+ One identifier, fnname, in func.go was poorly named. It has been renamed
37+ to fnName. Another identifier retval was not needed and has been removed
38+ entirely.
39+ ```
40+
41+ > __ Note:__ [ conventional commits] ( https://www.conventionalcommits.org/en/v1.0.0/#summary ) style is not enforced however is alowed
You can’t perform that action at this time.
0 commit comments