|
2 | 2 | title: Contributor Guide |
3 | 3 | --- |
4 | 4 |
|
5 | | -todo: make this friendlier and more complete |
| 5 | +Hi! We, the maintainers, are really excited that you are interested in contributing to Tauri. Before submitting your contribution though, please make sure to take a moment and read through the [Code of Conduct](https://github.com/tauri-apps/tauri/blob/dev/.github/CODE_OF_CONDUCT.md), as well as the appropriate section for the contribution you intend to make: |
6 | 6 |
|
7 | | -Tauri is a polyglot system that uses: |
| 7 | +- [Issue Reporting Guidelines](#issue-reporting-guidelines) |
| 8 | +- [Pull Request Guidelines](#pull-request-guidelines) |
| 9 | +- [Development Guide](#development-guide) |
8 | 10 |
|
9 | | -- git |
10 | | -- Node.js |
11 | | -- Rust |
12 | | -- GitHub actions |
| 11 | +## Issue Reporting Guidelines |
13 | 12 |
|
14 | | -It can be developed on macOS, Linux and Windows. |
| 13 | +- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately. |
15 | 14 |
|
16 | | -## Contribution Flow |
| 15 | +- If you have a question, you can get quick answers from the [Tauri Discord chat](https://discord.gg/SpmNs4S). |
17 | 16 |
|
18 | | -1. File an Issue |
19 | | -2. Fork the Repository |
20 | | -3. Make Your Changes |
21 | | -4. Make a PR |
| 17 | +- Try to search for your issue, it may have already been answered or even fixed in the development branch (`dev`). |
22 | 18 |
|
23 | | -### A Note About Contributions to the Rust Libraries |
| 19 | +- Check if the issue is reproducible with the latest stable version of Tauri. If you are using a pre-release, please indicate the specific version you are using. |
24 | 20 |
|
25 | | -When contributing to the Rust libraries `tauri`, `tauri-api`, and `tauri-updater`; you will want to setup an environment for RLS (the Rust Language Server). In the Tauri root directory, there is a `.scripts` folder that contains a set of scripts to automate adding a couple temporary environment variables to your shell/terminal. These environment variables point to directories in the test fixture which will prevent RLS from crashing on compile-time. This is a necessary step for setting up a development environment for Tauri's Rust libraries. |
| 21 | +- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable. |
26 | 22 |
|
27 | | -##### _Example Instructions_ |
| 23 | +- Use only the minimum amount of code necessary to reproduce the unexpected behavior. A good bug report should isolate specific methods that exhibit unexpected behavior and precisely define how expectations were violated. What did you expect the method or methods to do, and how did the observed behavior differ? The more precisely you isolate the issue, the faster we can investigate. |
28 | 24 |
|
29 | | -1. Navigate to the Tauri Root directory. |
30 | | -2. Execute a script based on your Operating System from this folder: `.scripts/init_env.bat` for Windows Cmd, `.scripts/init_env.ps1` for Windows Powershell, `. .scripts/init_env.sh` for Linux/macOS bash (note the first `.` in this command). |
31 | | -3. Open your text editor/IDE from this shell/terminal. |
| 25 | +- Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed. |
32 | 26 |
|
33 | | -## Hands On Example |
| 27 | +- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it. |
34 | 28 |
|
35 | | -Let's make a new example. That's a great way to learn. We are going to assume you are on a nixy type of environment like Linux or macOS and have all of your development dependencies like rust and node already sorted out. |
| 29 | +- Most importantly, we beg your patience: the team must balance your request against many other responsibilities — fixing other bugs, answering other questions, new features, new documentation, etc. The issue list is not paid support and we cannot make guarantees about how fast your issue can be resolved. |
36 | 30 |
|
37 | | -```sh |
38 | | -git clone [email protected]:tauri-apps/tauri.git |
39 | | -cd tauri/cli/tauri.js |
40 | | -yarn |
41 | | -mkdir ../../examples/vanillajs && cd "$_" |
42 | | -``` |
| 31 | +## Pull Request Guidelines |
43 | 32 |
|
44 | | -```json |
45 | | - "tauri:source": "node ../../../cli/tauri.js/bin/tauri", |
46 | | -``` |
| 33 | +- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging. |
| 34 | + |
| 35 | +- If adding new feature: |
| 36 | + |
| 37 | + - Provide a convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. |
| 38 | + |
| 39 | +- If fixing a bug: |
| 40 | + - If you are resolving a special issue, add `(fix: #xxxx[,#xxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `fix: update entities encoding/decoding (fix #3899)`. |
| 41 | + - Provide a detailed description of the bug in the PR, or link to an issue that does. |
| 42 | + |
| 43 | +## Development Guide |
| 44 | + |
| 45 | +**NOTE: Tauri is undergoing rapid development right now, and the docs match the latest published version of Tauri. This contributor guide is up-to-date, but it doesn't cover all of Tauri's functions in depth. If you have any questions, don't hesitate to ask in our Discord server.** |
| 46 | + |
| 47 | +### General Setup |
| 48 | + |
| 49 | +First, [join our Discord server](https://discord.gg/SpmNs4S) and let us know that you want to contribute. This way we can point you in the right direction and help ensure your contribution will be as helpful as possible. |
| 50 | + |
| 51 | +To set up your machine for development, follow the [Tauri setup guide](https://tauri.studio/en/docs/getting-started/intro#setting-up-your-environment) to get all the tools you need to develop Tauri apps. The only additional tool you may need is [Yarn](https://yarnpkg.com/), it is only required if you are developing the Node CLI/API (`tooling/cli.js` and `api`). Next, fork and clone this repo. It is structured as a monorepo, which means that all the various Tauri packages are under the same repository. The development process varies depending on what part of Tauri you are contributing to, see the guides below for per-package instructions. |
| 52 | + |
| 53 | +Some Tauri packages will be automatically built when running one of the examples. Others, however, will need to be built beforehand. To build these automatically, run the `.scripts/setup.sh` (Linux and macOS) or `.scripts/setup.ps1` (Windows) script. This will install the Rust and Node.js CLI and build the JS API. After that, you should be able to run all the examples. |
| 54 | + |
| 55 | +### Packages Overview |
| 56 | + |
| 57 | +- The JS API (`/tooling/api`) contains JS bindings to the builtin Rust functions in the Rust API. |
| 58 | +- The Rust CLI (`/tooling/cli.rs`) is the primary CLI for creating and developing Tauri apps. |
| 59 | +- cli.js (`/tooling/cli.js`) is a Node.js CLI wrapper for `cli.rs`. |
| 60 | +- Tauri Bundler (`/tooling/bundler`) is used by the Rust CLI to package executables into installers. |
| 61 | +- Tauri Core (`/core/tauri`) is the heart of Tauri. It contains the code that starts the app, configures communication between Rust and the Webview, and ties all the other packages together. |
| 62 | +- The Macros (`/core/tauri-macros`) are used by Tauri Core for various functions. |
47 | 63 |
|
48 | | -```ini |
49 | | - [dependencies.tauri] |
50 | | - path = "../../../../core/tauri" |
51 | | - features = [ "all-api" ] |
| 64 | +### Developing The Node.js CLI (cli.js) |
| 65 | + |
| 66 | +`cli.js` is a CLI tool that houses the `icon`, and `deps` command. The code for cli.js is located in `[Tauri repo root]/tooling/cli.js`. There are a few package scripts you should be aware of: |
| 67 | + |
| 68 | +- `build` builds the CLI |
| 69 | +- `test` runs the unit and e2e test suite |
| 70 | +- `lint` runs ESLint to catch linting errors |
| 71 | +- `format` formats code with Prettier to match the style guide |
| 72 | + |
| 73 | +To test your changes, we recommend using the helloworld example app, located in `[Tauri repo root]/examples/helloworld`. Run `yarn tauri [COMMAND]` to run a command using your local cli.js copy. You will need to rebuild cli.js after every change by running `yarn build` in the cli.js directory. |
| 74 | + |
| 75 | +If you want to use your local copy of cli.js in another app, we recommend using [yarn link](https://classic.yarnpkg.com/en/docs/cli/link/). First, make sure you have don't have cli.js installed globally by running `npm uninstall -g tauri && yarn global remove tauri`. Then, run `yarn link` in the cli.js directory (note that the setup script will do this for you, so you can skip this step if you ran that). Now, you can just run `tauri [COMMAND]` anywhere, and your local copy will be used. |
| 76 | + |
| 77 | +### Developing Tauri Bundler and Rust CLI |
| 78 | + |
| 79 | +The code for the bundler is located in `[Tauri repo root]/tooling/bundler`, and the code for the Rust CLI is located in `[Tauri repo root]/tooling/cli.rs`. If you are using your local copy of cli.js (see above), any changes you make to the bundler and CLI will be automatically built and applied when running the build or dev command. Otherwise, running `cargo install --path .` in the Rust CLI directory will allow you to run `cargo tauri build` and `cargo tauri dev` anywhere, using the updated copy of the bundler and cli. You will have to run this command each time you make a change in either package. |
| 80 | + |
| 81 | +### Developing Tauri Core and Related Components (Rust API, Macros, Codegen, and Utils) |
| 82 | + |
| 83 | +The code for Tauri Core is located in `[Tauri repo root]/core/tauri`, and the Rust API, Macros, and Utils are in `[Tauri repo root]/core/tauri-(api/macros/utils)`. The easiest way to test your changes is to use the `[Tauri repo root]/examples/helloworld` app. It automatically rebuilds and uses your local copy of the Tauri core packages. Just run `yarn tauri build` or `yarn tauri dev` in the helloworld app directory after making changes to test them out. To use your local changes in another project, edit its `src-tauri/Cargo.toml` file so that the `tauri` key looks like `tauri = { path = "PATH", features = [ "api-all", "cli" ] }`, where `PATH` is the relative path to `[Tauri repo root]/core/tauri`. Then, your local copy of the Tauri core packages will be rebuilt and used whenever you build that project. |
| 84 | + |
| 85 | +#### Building the documentation locally |
| 86 | + |
| 87 | +You can build the Rust documentation locally running the following script: |
| 88 | + |
| 89 | +```bash |
| 90 | +$ RUSTDOCFLAGS="--cfg doc_cfg" cargo +nightly doc --all-features --open |
52 | 91 | ``` |
| 92 | + |
| 93 | +### Developing the JS API |
| 94 | + |
| 95 | +The JS API provides bindings between the developer's JS in the Webview and the builtin Tauri APIs, written in Rust. Its code is located in `[Tauri repo root]/tooling/api`. After making changes to the code, run `yarn build` to build it. To test your changes, we recommend using the API example app, located in `[Tauri repo root]/examples/api`. It will automatically use your local copy of the JS API and provides a helpful UI to test the various commands. |
0 commit comments