Skip to content

Commit

Permalink
docs: handle main branch name (#497)
Browse files Browse the repository at this point in the history
* docs: update documentation to point to main branch files

* docs: change main branch name in native readme
  • Loading branch information
jacobvenable authored Oct 18, 2021
1 parent 774d04f commit cea708c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit cea708c

Please sign in to comment.