Contributing
Excited to hear that you are interested in contributing to this project! Thanks!
Documentation
The easiest way to contribute documentation to this project is to follow these steps:
- Fork the repository.
- Clone the newly forked repo from your GitHub account.
- Create a new branch to add your work to, i.e. git checkout -b client/feat/xxx.
- Make your changes and commit them
- Push the branch to your fork
- Go to https://github.com/Tencent/cherry-markdown/pulls, there should be a "Compare & Pull Request" button, where you can create a PR.
Setup (locally)
This client project is developed using Node+rust, so you must first ensure that the development environment is correct.
- The first step is to install rust.
- And you need to install node too(It is recommended to use nvm or nvm-windows to install).
This project uses pnpm to manage the dependencies, install it if you haven't via.
npm i -g pnpm
Clone this repo to your local machine and install the dependencies.
pnpm install
Tip
If you are using another package manager, you need to pay attention to client/tauri.conf.json configuration.
build.beforeDevCommand:your package manager dev
build.beforeBuildCommand:your package manager dev
Then you can use yarn/npm/pnpm to build the project.
Development
- Build with watch mode.
pnpm tauri:dev
- To build all the packages at once, run the following command on the project root.
pnpm tauri:build
More
- Now using tauri v2.0.