diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 2baa45ce..dbb72028 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,18 +1,18 @@ ## Contributing Guide -Contributing is welcome, if you find some bugs or have some ideas, please open an issue or submit a pull request. +Contributions are 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 ensure that you are using clean code, following the coding style and code organization in existing code, and make sure all the tests pass. -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. +Please submit one PR that does one thing, this is important, and helps 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. +There are a lot of UI test cases in the `crates/story` folder, if you change the existing features you can run the tests to make sure they are working. ### Run story -Use `cargo run` to run a complete story examples. +Use `cargo run` to run the complete story examples to display them all in a gallery of GPUI components. ```bash cargo run @@ -20,7 +20,7 @@ cargo run ### Run single example -There also available some split examples, run `cargo run --example` to see the available examples. +There is also available some split examples, run `cargo run --example` to see the available examples. ```bash cargo run --example table