kunkun-extensions-mirror/kunkunsh-kunkun-ext-neohtop
1
0
Fork 0
mirror of https://github.com/kunkunsh/kunkun-ext-neohtop.git synced 2025-04-04 09:46:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme: dev setup

Browse Source
This commit is contained in:
Abdenasser 2024-11-10 14:58:22 +01:00
parent 25f51a50cd
commit 24f0f331b8
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -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.