rust-sdk/docs/CONTRIBUTE.MD
4t145 55215b6170
chore: cov settings, and fix serveral building warnings (#281)
* chore: cov settings, update Python test dependencies and adjust command arguments

* fix: remove .vscode dir
2025-06-25 14:30:45 +08:00

33 lines
No EOL
1,010 B
Markdown

# Discuss first
If you have a idea, make sure it is discussed before you make a PR.
# Fmt And Clippy
You can use [just](https://github.com/casey/just) to help you fix your commit rapidly:
```shell
just fix
```
# How Can I Rewrite My Commit Message?
You can `git reset --soft upstream/main` and `git commit --forge`, this will merge your changes into one commit.
Or you also can use git rebase. But we will still merge them into one commit when it is merged.
# Check Code Coverage
If you are developing on vscode, you can use vscode plugin [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
And also need to install llvm-cov
```sh
cargo install cargo-llvm-cov
rustup component add llvm-tools-preview
```
If you are using goverage gutters plugin, add these config to let it know lcov output.
```json
{
"coverage-gutters.coverageFileNames": [
"coverage.lcov",
],
"coverage-gutters.coverageBaseDir": "target/llvm-cov-target",
}
```