Browse Source

change: `dora/node-hub/README.md` (#862)

- This PR contains a small change that came as pain point for me. It
might help others to get rid of it.
- Here is the
[suggestion](https://github.com/dora-rs/dora/pull/853#discussion_r1993435899)
tags/v0.3.11-rc1
Haixuan Xavier Tao GitHub 10 months ago
parent
commit
354a39d149
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 0 deletions
  1. +22
    -0
      node-hub/README.md

+ 22
- 0
node-hub/README.md View File

@@ -98,6 +98,28 @@ dev = ["pytest >=8.1.1", "ruff >=0.9.1"]
opencv-plot = "opencv_plot.main:main"

```
## Adding git dependency
- If a git repository is added as submodule. Proper path should be added in `pyproject.toml` inorder to make sure that linting and testing are exempted for that dependency.
- A very good example of how this can be done is as follows

Correct approach:
```toml
[tool.ruff]
exclude = ["dora_magma/Magma"]

[tool.black]
extend.exclude = "dora_magma/Magma"
```
Incorrect Approach:
```toml
[tool.ruff]
exclude = ["dora-magma/dora_magma/Magma"]

[tool.black]
extend.exclude = "dora_magma/Magma"
```
##### Note:
- `dora-magma` is root folder of the node.

## License



Loading…
Cancel
Save