tauri-apps/tauri.studio
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri.studio.git synced 2026-02-04 02:21:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

add rust contribution instructions

Browse Source
This commit is contained in:
tensor-programming
2019-12-30 16:57:48 -05:00
parent 29f7258303
commit e699a7a04e
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
wiki_pages/14. Contributor Introduction.md
View File

@@ -11,10 +11,18 @@ Tauri is a polyglot system that uses:
It can be developed on Mac, Linux and Windows.
## Contribution Flow
File an Issue
Fork the Repository
Make your Changes
Make a PR
1. File an Issue
2. Fork the Repository
3. Make your Changes
4. Make a PR
### A Note About Contributions to the Rust Libraries
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 environmental variables to your shell/terminal. These environment variables point to directories in a 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.
##### *Example Instructions*
1. Navigate to the Tauri Root directory.
2. Execute a script based on your environment from this folder: `.scripts/init_env.bat` for cmd, `.scripts/init_env.ps1` for powershell, `. .scripts/init_env.sh` for bash.
3. Open your text editor/IDE from this command line.
## Hands On Example
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.