Skip to content

Commit f1f39e8

Browse files
author
Vipin Jain
committed
move CONTRIBUTING.md to root level
1 parent 69e32f5 commit f1f39e8

File tree

1 file changed

+113
-0
lines changed

1 file changed

+113
-0
lines changed

CONTRIBUTING.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
## Contributing to Netplugin
2+
3+
There are many ways to contribute - report issues, suggest doc changes,
4+
submit bug fixes, propose design changes, discuss use cases, propose
5+
interop with other ecosystem software, or become a maintainer.
6+
7+
All contributions, big or small are welcome!
8+
9+
### Reporting Issues
10+
Usage or non code related issues can be reported by clicking `New Issue` on
11+
[netplugin's issues on github](https://github.com/contiv/netplugin/issues).
12+
A feature request can also be submitted as an issue.
13+
14+
However if there is an issue with running the netplugin binary, providing following
15+
information would shorten the debug time:
16+
- Version of container runtime (e.g. docker), state driver (e.g. etcd),
17+
netplugin version, driver (e.g. ovs), Operating System version, and other
18+
applicable information.
19+
- Steps to reproduce, if any
20+
- Backtrace, if applicable
21+
22+
### Suggesting a doc change, or submitting a bug fix
23+
Just go ahead and submit a PR, one of the maintainers would review the diffs
24+
and provide feedback. After discussions, as the changes look good, they will
25+
be merged into the master. Please make sure you run the unit and system tests
26+
before submitting the PR.
27+
28+
### Proposing a design change
29+
If you would like to refactor the code, propose a new design component, or
30+
introduce a significant change, please discuss it as an issue titled as
31+
`Proposal: ...` in order for people to provide feedback early enough.
32+
Making significant code changes before design discussion may waste
33+
time, therefore it is discouraged.
34+
35+
After design discussions:
36+
- Fork a private repo
37+
- Make the changes in the private repo
38+
- Add unit and system test cases for your code
39+
- Make sure existing tests and newly added tests pass
40+
- Merge your changes with the latest in the master branch
41+
- Re-run the unit and system tests
42+
- Submit a PR with the code changes
43+
- This would involve discussions and few adjustments may need to be made.
44+
It is encouraged to engage into discussions during the coding phase as well.
45+
- After `LGTM` from maintainers, re-run unit and system tests
46+
- One of the maintainers would merge your changes into the appropriate release candidate
47+
48+
49+
### Discussing use cases and requesting new features
50+
Bring up your use cases by submitting an issue. Describe the use case that
51+
is not handled in the latest version. Issues that seek new features should
52+
be titled as `Feature Request: ...`. It is encouraged to include diagrams
53+
(pics of hand drawn diagrams is just fine), or other details that best
54+
describes a use case.
55+
56+
### Becoming a maintainer
57+
Of course, play with the code, know is inside out - and you will know if you
58+
are ripe to become a maintainer. If you think you are ready, drop an eamil
59+
to any of the maintainers.
60+
61+
### Legal Stuff: Sign your work
62+
You must sign-off your work by adding your signature at the end of
63+
patch description. Your signature certifies that you wrote the patch or
64+
otherwise have the right to pass it on as an open-source patch.
65+
By signing off your work you ascertain following (from [developercertificate.org](http://developercertificate.org/)):
66+
67+
```
68+
Developer Certificate of Origin
69+
Version 1.1
70+
71+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
72+
660 York Street, Suite 102,
73+
San Francisco, CA 94110 USA
74+
75+
Everyone is permitted to copy and distribute verbatim copies of this
76+
license document, but changing it is not allowed.
77+
78+
Developer's Certificate of Origin 1.1
79+
80+
By making a contribution to this project, I certify that:
81+
82+
(a) The contribution was created in whole or in part by me and I
83+
have the right to submit it under the open source license
84+
indicated in the file; or
85+
86+
(b) The contribution is based upon previous work that, to the best
87+
of my knowledge, is covered under an appropriate open source
88+
license and I have the right under that license to submit that
89+
work with modifications, whether created in whole or in part
90+
by me, under the same open source license (unless I am
91+
permitted to submit under a different license), as indicated
92+
in the file; or
93+
94+
(c) The contribution was provided directly to me by some other
95+
person who certified (a), (b) or (c) and I have not modified
96+
it.
97+
98+
(d) I understand and agree that this project and the contribution
99+
are public and that a record of the contribution (including all
100+
personal information I submit with it, including my sign-off) is
101+
maintained indefinitely and may be redistributed consistent with
102+
this project or the open source license(s) involved.
103+
```
104+
105+
Then you just add a line to every git commit message:
106+
107+
Signed-off-by: Joe Smith <[email protected]>
108+
109+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
110+
111+
If you set your `user.name` and `user.email` git configs, you can sign your
112+
commit automatically with `git commit -s`.
113+

0 commit comments

Comments
 (0)