Skip to content

Commit 93ce186

Browse files
committed
Update README
1 parent 3ecb63a commit 93ce186

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

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+
For 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.
2622

23+
Happy hacking!
2724

2825
## License
2926

0 commit comments

Comments
 (0)