Skip to content

Commit 7910840

Browse files
committed
docs: add contributing md
1 parent a58f909 commit 7910840

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to nano-graphrag
2+
3+
### Submit your Contribution through PR
4+
5+
To make a contribution, follow these steps:
6+
7+
1. Fork and clone this repository
8+
3. If you modified the core code (`./nano_graphrag`), please add tests for it
9+
4. **Include proper documentation / docstring or examples**
10+
5. Ensure that all tests pass by running `pytest`
11+
6. Submit a pull request
12+
13+
For more details about pull requests, please read [GitHub's guides](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
14+
15+
16+
17+
### Only add a dependency when we have to
18+
19+
`nano-graphrag` needs to be `nano` and `light`. If we want to add more features, we add them smartly. Don't introduce a huge dependency just for a simple function.

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,12 @@ See [ROADMAP.md](./docs/ROADMAP.md)
343343

344344

345345

346+
## Contribute
347+
348+
`nano-graphrag` is open to any kind of contribution. Read [this](./CONTRIBUTING.md) before you contribute.
349+
350+
351+
346352

347353
## Benchmark
348354

0 commit comments

Comments
 (0)