docs: update
This commit is contained in:
parent
8b5c36c983
commit
5333b9548b
|
|
@ -27,44 +27,53 @@ Contributions are welcome! Here's how you can help improve AppFlowy Cloud:
|
||||||
|
|
||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
||||||
> Please check out this [guide](./GUIDE.md) before you start coding.
|
Before diving into development, familiarize yourself with the codebase and project standards by reviewing the [Development Guide](./GUIDE.md).
|
||||||
|
|
||||||
To get the server running locally, execute:
|
### Setting Up the Local Server
|
||||||
|
|
||||||
|
To start the server on your local machine, run the following script:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./build/run_local_server.sh
|
./build/run_local_server.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
Ensure functionality by executing the test suite:
|
### Testing
|
||||||
|
|
||||||
|
Verify that your changes work as expected by running the test suite:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo test
|
cargo test
|
||||||
```
|
```
|
||||||
|
|
||||||
For a pull request (PR) to be considered, it must:
|
### Pull Request (PR) Requirements
|
||||||
|
|
||||||
- Pass all tests.
|
For a pull request to be accepted, it must satisfy the following criteria:
|
||||||
- Adhere to [`clippy`](https://github.com/rust-lang/rust-clippy) linting standards:
|
|
||||||
|
|
||||||
```bash
|
1. **Pass All Tests**: Your PR should not break any existing functionality and must pass all the automated tests.
|
||||||
cargo clippy -- -D warnings
|
|
||||||
```
|
|
||||||
|
|
||||||
If `clippy` is not installed:
|
2. **Linting with Clippy**: Your code must adhere to the linting standards enforced by [`clippy`](https://github.com/rust-lang/rust-clippy). You can check for linting issues using:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
rustup update
|
cargo clippy -- -D warnings
|
||||||
rustup component add clippy
|
```
|
||||||
```
|
|
||||||
|
|
||||||
- Comply with the code formatting rules. To format your code:
|
If `clippy` isn't already installed:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo fmt
|
rustup update
|
||||||
```
|
rustup component add clippy
|
||||||
|
```
|
||||||
|
|
||||||
To check formatting:
|
3. **Code Formatting**: The code must comply with established formatting rules. Use the following commands for formatting and checking your code:
|
||||||
|
|
||||||
```bash
|
To format your code:
|
||||||
cargo fmt --all -- --check
|
|
||||||
```
|
```bash
|
||||||
|
cargo fmt
|
||||||
|
```
|
||||||
|
|
||||||
|
To validate formatting:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo fmt --all -- --check
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# Using AppFlowy with AppFlowy Cloud
|
|
||||||
|
|
||||||
WIP
|
|
||||||
Loading…
Reference in New Issue