diff --git a/README.md b/README.md index 5accb73..d6b5610 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,31 @@ npm run tauri build npm run tauri build -- --bundles app --config "{\"bundle\":{\"macOS\":{\"signingIdentity\":null}}}" ``` +### Development Setup + +The project uses pre-commit hooks to ensure code consistency. After cloning and installing dependencies, the pre-commit hooks will be automatically installed. + +#### Code Formatting + +We use Prettier for web code and `cargo fmt` for Rust code. Format your code using: + +```bash +# Format all files +npm run format + +# Check formatting without making changes +npm run format:check +``` + +The pre-commit hook will automatically format your code when you commit, but you can run the formatter manually at any time. + +#### Pull Requests + +Before submitting a PR, please ensure: +1. All code is formatted (`npm run format`) +2. The format check passes (`npm run format:check`) +3. Your commits follow the project's commit message conventions + ## Contributing We welcome contributions from the community! Please see our [contributing guidelines](./.github/CONTRIBUTING.md) for more information.