You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+53-1Lines changed: 53 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,58 @@ Please follow the steps below and be sure that your contribution complies with o
29
29
1. The <a href="https://github.com/Xilinx/finn" target="_blank">main branch</a> should always be treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed to be very important such that without this fix, a lot of things will break.
30
30
2. For new features, smaller bug fixes, doc updates, and many other fixes, users should pull request against the <a href="https://github.com/Xilinx/finn/tree/dev" target="_blank">development branch</a>.
31
31
32
-
3. We will review your contribution and, if any additional fixes or modifications are
32
+
3.### 3. Sign Your Work
33
+
34
+
Please use the *Signed-off-by* line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) defined by https://developercertificate.org/ reproduced below::
35
+
36
+
```
37
+
Developer Certificate of Origin
38
+
Version 1.1
39
+
40
+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
41
+
1 Letterman Drive
42
+
Suite D4700
43
+
San Francisco, CA, 94129
44
+
45
+
Everyone is permitted to copy and distribute verbatim copies of this
46
+
license document, but changing it is not allowed.
47
+
48
+
49
+
Developer's Certificate of Origin 1.1
50
+
51
+
By making a contribution to this project, I certify that:
52
+
53
+
(a) The contribution was created in whole or in part by me and I
54
+
have the right to submit it under the open source license
55
+
indicated in the file; or
56
+
57
+
(b) The contribution is based upon previous work that, to the best
58
+
of my knowledge, is covered under an appropriate open source
59
+
license and I have the right under that license to submit that
60
+
work with modifications, whether created in whole or in part
61
+
by me, under the same open source license (unless I am
62
+
permitted to submit under a different license), as indicated
63
+
in the file; or
64
+
65
+
(c) The contribution was provided directly to me by some other
66
+
person who certified (a), (b) or (c) and I have not modified
67
+
it.
68
+
69
+
(d) I understand and agree that this project and the contribution
70
+
are public and that a record of the contribution (including all
71
+
personal information I submit with it, including my sign-off) is
72
+
maintained indefinitely and may be redistributed consistent with
73
+
this project or the open source license(s) involved.
74
+
```
75
+
76
+
Here is an example Signed-off-by line which indicates that the contributor accepts DCO::
FINN is an experimental framework from Xilinx Research Labs to explore deep neural network
11
-
inference on FPGAs.
10
+
FINN is an experimental framework from Integrated Communications and AI Lab of AMD Research & Advanced Development to explore deep neural network inference on FPGAs.
12
11
It specifically targets <ahref="https://github.com/maltanar/qnn-inference-examples"target="_blank">quantized neural
13
12
networks</a>, with emphasis on
14
13
generating dataflow-style architectures customized for each network.
@@ -28,7 +27,7 @@ Please see the [Getting Started](https://finn.readthedocs.io/en/latest/getting_s
28
27
29
28
## Documentation
30
29
31
-
You can view the documentation on [readthedocs](https://finn.readthedocs.io) or build them locally using `python setup.py doc` from inside the Docker container. Additionally, there is a series of [Jupyter notebook tutorials](https://github.com/Xilinx/finn/tree/main/notebooks), which we recommend running from inside Docker for a better experience.
30
+
You can view the documentation on [readthedocs](https://finn.readthedocs.io). Additionally, there is a series of [Jupyter notebook tutorials](https://github.com/Xilinx/finn/tree/main/notebooks), which we recommend running from inside Docker for a better experience.
0 commit comments