diff --git a/DEVELOPMENT b/DEVELOPMENT index be729002..2baa45ce 100644 --- a/DEVELOPMENT +++ b/DEVELOPMENT @@ -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 ``` diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 00000000..c5794a6b --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "1.85"