yujunjun/graphrag
1
0
Fork 0
mirror of https://github.com/microsoft/graphrag.git synced 2025-08-31 12:00:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update developer guide (#1029)

Browse Source
This commit is contained in:
Josh Bradley 2024-08-26 12:28:03 -04:00 committed by GitHub
parent 55e74a0c2e
commit fd8e56ce6f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.semversioner/next-release/patch-20240826160100086489.json Normal file
View File

@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Update developer guide."
}

12
DEVELOPING.md
View File

@ -16,7 +16,7 @@
poetry install
```
## Execute the Indexing Engine
## Executing the Indexing Engine
```sh
poetry run poe index <...args>
@ -28,6 +28,13 @@ poetry run poe index <...args>
poetry run poe query <...args>
```
## Versioning
We use [semversioner](https://github.com/raulgomis/semversioner) to automate and enforce semantic versioning in the release process. Our CI/CD pipeline checks that all PR's include a json file generated by semversioner. When submitting a PR, please run:
```shell
poetry run semversioner add-change -t patch -d "<a small sentence describing changes made>."
```
# Azurite
Some unit and smoke tests use Azurite to emulate Azure resources. This can be started by running:
@ -40,10 +47,9 @@ or by simply running `azurite` in the terminal if already installed globally. Se
# Lifecycle Scripts
Our Python package utilizes Poetry to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage build scripts.
Our Python package utilizes Poetry to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage custom build scripts.
Available scripts are:
- `poetry run poe index` - Run the Indexing CLI
- `poetry run poe query` - Run the Query CLI
- `poetry build` - This invokes `poetry build`, which will build a wheel file and other distributable artifacts.