doc: Update Contributing Guide. (#739)

Close #737
This commit is contained in:
Jason Lee 2025-03-26 21:46:42 +08:00 committed by GitHub
parent 814ea0e824
commit a587c87a85
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 21 additions and 3 deletions

View file

@ -1,11 +1,27 @@
## Run story
## Contributing Guide
Contributing is welcome, if you find some bugs or have some ideas, please open an issue or submit a pull request.
Please ensure that you are using clean code, follows the coding style or code organization in exists codes, and pass all tests.
Please submit one PR for do one thing, this is important, that for help us to review your code more easily and push to merge fast.
## Development and Testing
There have a lot of UI test cases in `crates/story` folder, if you change the exists features you can run the tests is working.
### Run story
Use `cargo run` to run a complete story examples.
```bash
cargo run
```
## Run Tiles example
### Run single example
There also available some split examples, run `cargo run --example` to see the available examples.
```bash
cargo run --example tiles
cargo run --example table
```

2
rust-toolchain.toml Normal file
View file

@ -0,0 +1,2 @@
[toolchain]
channel = "1.85"