From e7d0a81bfec1b69ddfce522c41615bc3c7de729f Mon Sep 17 00:00:00 2001 From: Benjamin B <7598058+BBlackwo@users.noreply.github.com> Date: Fri, 27 May 2022 13:45:59 +1000 Subject: [PATCH] Fix links in CONTRIBUTING.md, update ToC --- CONTRIBUTING.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c6aa4097..f72e3da5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,9 @@ All types of contributions are encouraged and valued. See the [Table of Contents - [I Want To Contribute](#i-want-to-contribute) - [Reporting Bugs](#reporting-bugs) - [Suggesting Enhancements](#suggesting-enhancements) + - [Project Structure](#project-structure) - [Your First Code Contribution](#your-first-code-contribution) - - [Setting Up Your Development Environment](#setting-up-your-development-environment) + - [Setting up your development environment](#setting-up-your-development-environment) - [Building The Image](#building-the-image) - [Improving The Documentation](#improving-the-documentation) - [Styleguides](#styleguides) @@ -134,15 +135,17 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/Start9 ### Project Structure + EmbassyOS is composed of the following components. Please visit the README for each component to understand the dependency requirements and installation instructions. -- [`ui`](ui/README.md) (Typescript Ionic Angular) is the code that is deployed to the browser to provide the user interface for EmbassyOS. -- [`backend`] (backend/README.md) (Rust) is a command line utility, daemon, and software development kit that sets up and manages services and their environments, provides the interface for the ui, manages system state, and provides utilities for packaging services for EmbassyOS. +- [`ui`](frontend/README.md) (Typescript Ionic Angular) is the code that is deployed to the browser to provide the user interface for EmbassyOS. +- [`backend`](backend/README.md) (Rust) is a command line utility, daemon, and software development kit that sets up and manages services and their environments, provides the interface for the ui, manages system state, and provides utilities for packaging services for EmbassyOS. - `patch-db` - A diff based data store that is used to synchronize data between the front and backend. - - Notably, `patch-db` has a [client](patch-db/client/README.md) with its own dependency and installation requirements. + - Notably, `patch-db` has a [client](https://github.com/Start9Labs/patch-db/tree/master/client) with its own dependency and installation requirements. - `rpc-toolkit` - A library for generating an rpc server with cli bindings from Rust functions. - `system-images` - (Docker, Rust) A suite of utility Docker images that are preloaded with EmbassyOS to assist with functions relating to services (eg. configuration, backups, health checks). -- [`setup-wizard`] (ui/README.md)- Code for the user interface that is displayed during the setup and recovery process for EmbassyOS. -- [`diagnostic-ui`] (diagnostic-ui/README.md) - Code for the user interface that is displayed when something has gone wrong with starting up EmbassyOS, which provides helpful debugging tools. +- [`setup-wizard`](frontend/README.md)- Code for the user interface that is displayed during the setup and recovery process for EmbassyOS. +- [`diagnostic-ui`](frontend/README.md) - Code for the user interface that is displayed when something has gone wrong with starting up EmbassyOS, which provides helpful debugging tools. + ### Your First Code Contribution #### Setting up your development environment @@ -188,7 +191,7 @@ The body of a pull request should contain sufficient description of what the cha You should include references to any relevant [issues](https://github.com/Start9Labs/embassy-os/issues). ### Rebasing Changes -When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch. The git rebase command will take care of rebuilding your commits on top of the new base. +When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch. The `git rebase` command will take care of rebuilding your commits on top of the new base. This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies auditability because merge commits can be assumed to not contain arbitrary code changes.