Skip to content

Commit 6a907cd

Browse files
committed
Update README and add DCO
1 parent 4695433 commit 6a907cd

File tree

2 files changed

+51
-14
lines changed

2 files changed

+51
-14
lines changed

DCO.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Developer Certificate of Origin
3+
---
4+
5+
```
6+
Developer Certificate of Origin
7+
Version 1.1
8+
9+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
10+
11+
Everyone is permitted to copy and distribute verbatim copies of this
12+
license document, but changing it is not allowed.
13+
14+
15+
Developer's Certificate of Origin 1.1
16+
17+
By making a contribution to this project, I certify that:
18+
19+
(a) The contribution was created in whole or in part by me and I
20+
have the right to submit it under the open source license
21+
indicated in the file; or
22+
23+
(b) The contribution is based upon previous work that, to the best
24+
of my knowledge, is covered under an appropriate open source
25+
license and I have the right under that license to submit that
26+
work with modifications, whether created in whole or in part
27+
by me, under the same open source license (unless I am
28+
permitted to submit under a different license), as indicated
29+
in the file; or
30+
31+
(c) The contribution was provided directly to me by some other
32+
person who certified (a), (b) or (c) and I have not modified
33+
it.
34+
35+
(d) I understand and agree that this project and the contribution
36+
are public and that a record of the contribution (including all
37+
personal information I submit with it, including my sign-off) is
38+
maintained indefinitely and may be redistributed consistent with
39+
this project or the open source license(s) involved.
40+
```

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
# ChipFlow library
22

3-
This is a small library to make working with the ChipFlow platform easy and straightforward.
3+
This is a library to make working with the ChipFlow platform easy and straightforward.
44

55
## Installation and usage
66

7-
This library uses [PDM](https://pdm.fming.dev/) for dependency management, testing, building, and publishing. Install PDM first. Then run:
7+
See the `ChipFlow docs <https://docs.chipflow.io>`__
88

9-
```
10-
pdm install
11-
```
129

13-
To run tests, use:
10+
## Contributing
1411

15-
```shell
16-
pdm run test
17-
```
12+
We warmly accept [PRs](https://github.com/chipFlow/chipflow-lib/pulls)
13+
and [issues](https://github.com/ChipFlow/chipflow-lib/issues), and are
14+
always happy for folk to join in [GitHub Discussions](https://github.com/ChipFlow/chipflow-central/discussions)
1815

19-
To run lints, use:
2016

21-
```shell
22-
pdm run lint
23-
```
17+
Code contributions must pass the following checks:
18+
- `pdm lint`
19+
- `pdm test`
2420

25-
Your contributions must pass the lint check to be included in the repository.
21+
Also, do note we have a [DCO](https://developercertificate.org/), and require sign-offs from external contributors.
2622

23+
Happy hacking!
2724

2825
## License
2926

0 commit comments

Comments
 (0)