From ae114448ba3ab09d6452a729db90b6f19966e410 Mon Sep 17 00:00:00 2001 From: jacobvenable Date: Mon, 18 Oct 2021 07:30:05 -0600 Subject: [PATCH 1/2] docs: update documentation to point to main branch files --- CONTRIBUTING.md | 4 ++-- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee2f7094a..6146ac153 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,8 @@ We also move issues into the [All Issues project](https://github.com/CodeForBoul Depending on your familiarity with the various stacks, you may also want to filter based on the two projects in this repo: -- **Server** - [issues](https://github.com/CodeForBoulder/upswyng/labels/Project%3A%20Server) related to the [server project](https://github.com/CodeForBoulder/upswyng/tree/master/packages/server) -- **Web** - [issues](https://github.com/CodeForBoulder/upswyng/labels/Project%3A%20Web) related to the [web project](https://github.com/CodeForBoulder/upswyng/tree/master/packages/web) +- **Server** - [issues](https://github.com/CodeForBoulder/upswyng/labels/Project%3A%20Server) related to the [server project](https://github.com/CodeForBoulder/upswyng/tree/main/packages/server) +- **Web** - [issues](https://github.com/CodeForBoulder/upswyng/labels/Project%3A%20Web) related to the [web project](https://github.com/CodeForBoulder/upswyng/tree/main/packages/web) ### Provide Feedback diff --git a/README.md b/README.md index 93bc95f30..7f4a9585a 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ Make sure you have these tools installed before you begin. UpSwyng is a monorepo managed with [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). It consists of five packages all in the `packages` directory: -- [common](https://github.com/CodeForBoulder/upswyng/tree/master/packages/common) - contains common libraries and utilities used across the other packages -- [types](https://github.com/CodeForBoulder/upswyng/tree/master/packages/types) - contains the TypeScript definitions used across the project -- [server](https://github.com/CodeForBoulder/upswyng/tree/master/packages/server) - a [Sapper](https://sapper.svelte.dev/) application with two parts: +- [common](https://github.com/CodeForBoulder/upswyng/tree/main/packages/common) - contains common libraries and utilities used across the other packages +- [types](https://github.com/CodeForBoulder/upswyng/tree/main/packages/types) - contains the TypeScript definitions used across the project +- [server](https://github.com/CodeForBoulder/upswyng/tree/main/packages/server) - a [Sapper](https://sapper.svelte.dev/) application with two parts: - an API server which provides data to the UpSwyng clients - an admin web interface which uses the [Svelte](https://svelte.dev/) framework to create and modify data for the project -- [web](https://github.com/CodeForBoulder/upswyng/tree/master/packages/web) - contains the [React](https://reactjs.org/) web client -- [native](https://github.com/CodeForBoulder/upswyng/tree/master/packages/native) - contains a proof-of-concept [React Native](https://facebook.github.io/react-native/) client +- [web](https://github.com/CodeForBoulder/upswyng/tree/main/packages/web) - contains the [React](https://reactjs.org/) web client +- [native](https://github.com/CodeForBoulder/upswyng/tree/main/packages/native) - contains a proof-of-concept [React Native](https://facebook.github.io/react-native/) client ## Working With Yarn Workspaces From bbb47715117764483a8eda096d002149ed849de5 Mon Sep 17 00:00:00 2001 From: jacobvenable Date: Mon, 18 Oct 2021 07:32:09 -0600 Subject: [PATCH 2/2] docs: change main branch name in native readme --- packages/native/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/native/README.md b/packages/native/README.md index eeb96b2a8..261d3ddbe 100644 --- a/packages/native/README.md +++ b/packages/native/README.md @@ -123,7 +123,7 @@ Maybe you have the answer to someone's question. Look through any issues labelle Once you have have found an issue you feel comfortable working on, request to work on the issue and we'll label the issue as **Status: In Progress** to make sure others don't work on it as well. -Then, create a new branch off the current `master`. +Then, create a new branch off the current `main`. ### 3. Create a Pull Request (PR)