diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15feab1..d3af229 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ - [Rust](#rust) - [VS Code Extensions](#vs-code-extensions) - [Run the program](#run-the-program) - - [Structure (Frontend v. Backend)](#structure-frontend-v-backend) + - [Now what?](#now-what) ## Introduction @@ -55,6 +55,10 @@ work, and that does not change with this repository. We file issues in this space, we collaborate in this space, send commits in this space, and more. +> [!TIP] +> +> Want to talk with the team? Feel free to join our Discord server! + ### Get in contact As of now, the best way to get in contact with us is through Carlos via @@ -89,7 +93,7 @@ Here's a few good examples: Since Iris is not yet production-ready, we are keeping all Iris-related documentation in the `docs` folder at the root of the repository. It's written -in simple Markdown! (That is... until we figure out ojosproject/iris#10) +in simple Markdown! Once Iris is production ready, we will be publishing the documents on [ojosproject.org](https://ojosproject.org/docs/). @@ -104,6 +108,9 @@ to see various examples of designs by us. If you'd like to help with this aspect of the project, please contact Carlos so that he gives you access to the Figma projects and gets you set up. +Ojos Project primarily uses [Figma](https://figma.com/) for our designs. Our +main designer is [Jesse](https://github.com/jessed7). + ### Community Building The Ojos Project doesn't just want to be centered around UCI. If you'd like to @@ -121,11 +128,6 @@ information. ### `git` policies -> [!IMPORTANT] -> Our git policies states that when you want to merge your work, you should -> use `dev`. Until we have a stable version of Iris, **please request to merge -> into `main`.** - Please make sure to follow our [git policies](https://ojosproject.org/docs/policies/git/). @@ -137,6 +139,7 @@ It may be useful to read the following resources before development: - [Thinking in React](https://react.dev/learn/thinking-in-react) - [NextJS App Routing Fundamentals](https://nextjs.org/docs/app/building-your-application/routing) - [Clear explanation of Rust’s module system](https://www.sheshbabu.com/posts/rust-module-system/) +- [Creating an Iris feature](./docs/create-a-feature.md) ### Setting up your coding environment @@ -149,9 +152,9 @@ cd iris #### Tauri Iris is written with a lot of different tools; however, we primarily use the -[Tauri](https://tauri.app/) framework. Before attempting to write any code, +[Tauri](https://tauri.app/) toolkit. Before attempting to write any code, please follow their -[prerequisite guide here](https://tauri.app/v1/guides/getting-started/prerequisites). +[prerequisite guide here](https://tauri.app/start/prerequisites/). #### Next.js @@ -172,7 +175,7 @@ type `@recommended` to see all of the extensions we use. Please install them. ### Run the program -After getting all tests, please install the npm dependencies: +Please install the npm dependencies: ```shell npm i @@ -182,6 +185,7 @@ npm i ```shell cargo tauri dev +# npm run tauri dev <-- also works! ``` > [!NOTE] @@ -189,13 +193,10 @@ cargo tauri dev > You can do so by running: > > ```shell -> cargo install tauri-cli@^2.0.0-rc +> cargo install tauri-cli --version "^2.0.0" --locked > ``` -### Structure (Frontend v. Backend) - -Our frontend code is inside the `/src/` folder at the root. It is written with -React and TypeScript using the Next.js framework. +### Now what? -Our backend code is inside the `/src-tauri/src/` folder. It is written in Rust -using the Tauri toolkit. Tauri connects everything together. +Start programming! A good place to start may be the +[Creating an Iris feature](./docs/create-a-feature.md) doc.