Contributing to WindowPet

First of all, thank you for considering contributing to our project! Your help and involvement are greatly appreciated.

Fork the Repository

1. Fork the repository on GitHub.

2. Clone your forked repository to your local machine:

   git clone https://github.com/your-name/WindowPet.git
   

3. Cd into the project directory:

   cd WindowPet
   

4. Switch to develop branch:

   git checkout dev
   

5. Keep your fork up to date:

   git pull origin dev
   

6. Create a new branch:

    git checkout -b your-branch-name
   

7. Make your changes and commit them:

   git commit -m 'Your commit message'
   

8. Push your changes to your fork:

   git push origin your-branch-name
   

9. Create a pull request to the dev branch of the original repository with some information about your changes.

Development

• Install rust and tauri refer to this link
  • Known working version of Rust is rustc 1.85.1 (4eb161250 2025-03-15).
• Install dependencies

npm install

✨ Run & Build

• Run the project

 npm run tauri dev

• Build the project

 npm run tauri build --release

• Note:
  • for build release we use github actions to build the project and upload the build to github release. You can check the build workflow here
  • If you want to host your own update release on your GitHub, simply generate your own signing key and replace the signing key in tauri.conf.json refer to tauri doc. Otherwise, during the build, you can ignore the password being asked after the build completes.