Skip to content

Commit bc9e820

Browse files
committed
Release 0.2.0
1 parent f364c84 commit bc9e820

File tree

192 files changed

+8544
-1466
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

192 files changed

+8544
-1466
lines changed

contributing/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060
## Enforcement
6161

6262
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the project members responsible for enforcement at the [Croquet Discord](https://croquet.io/discord).
63+
reported to the project members responsible for enforcement at the [Multisynq Discord](https://multisynq.dev/discord).
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All project members are obligated to respect the privacy and security of the

contributing/CONTRIBUTING.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If you decide to fix an [issue](https://github.com/multisynq/react-together/issu
4444

4545
### Development Workflow
4646

47-
#### Setting up locally
47+
#### Setting up locally
4848

4949
1. Clone the React Together repository from [GitHub](https://github.com/multisynq/react-together).
5050

@@ -79,20 +79,28 @@ react-together/
7979

8080
#### Branch Organization
8181

82-
The React Together repository uses the following branch structure:
82+
The React Together repository uses the [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model with the following branch structure:
8383

84-
```
85-
- website // Live version of the website
86-
- release // Latest stable version of npm packages
87-
- main // Staging area for packages and website (release-ready)
88-
- feature-x // Individual developer branches for work in progress
89-
```
84+
- `develop`: (default) main development branch
85+
- `feature-x`: individual developer branches for work in progress, to be merged into `develop`
86+
- `release-x`: branched off `develop` for new regular releases of npm packages, merged into `main`
87+
- `main`: latest stable release
88+
- `hotfix-x`: branched off `main` for hotfix releases, merged back into main
89+
90+
Here is an illustration (from [Git Kraken](https://www.gitkraken.com/learn/git/git-flow)):
91+
92+
![](git-flow.svg)
93+
94+
In addition, there are the website deployment branches:
95+
96+
- `deploy`: live version of [reacttogether.dev](https://reacttogether.dev)
97+
- `staging`: staging area for website at [staging.reacttogether.dev](https://staging.reacttogether.dev)
9098

9199
Important notes:
92100

93-
- The `website` branch should never contain documentation ahead of the `release` branch;
94-
- New features should be in their own branch and merged into `main`;
95-
- Bug fixes can be merged directly into the `main` branch;
101+
- The `deploy` branch should never contain documentation ahead of the `main` branch;
102+
- New features should be in their own branch and merged into `develop`;
103+
- Bug fixes can be merged into/developed directly on the `develop` branch;
96104

97105
#### Development commands
98106

@@ -112,13 +120,21 @@ To do so, delete `react-together` from your project's dependencies and run the f
112120
$ cd ~/path_to_your_react-together_clone/
113121
$ cd packages/react-together
114122
$ npm run build
115-
$ npm run link # Register package locally
123+
$ npm link # Register package locally
116124

117125
$ cd ~/path/to/your/project
118-
$ npm uninstall react-together # Remove npm version
119126
$ npm link react-together # Link to local version
120127
```
121128

129+
#### Package development
130+
131+
The package is written in TypeScript but distributed and imported as JavaScript. While developing, it is recommended to continuously rebuild the JavaScript so that your app uses the latest TypeScript package code:
132+
133+
``` bash
134+
$ cd packages/react-together
135+
$ npm run watch
136+
```
137+
122138
#### Editor extensions
123139

124140
If you are using VS Code, it may be useful to install the recommended extensions (if you don't have them already) and to ensure the project settings (under the `.vscode` directory) are in place. This will automate formatting and linting for you.
@@ -129,4 +145,4 @@ By contributing to React Together, you agree that your contributions will be lic
129145

130146
### Getting in Touch
131147

132-
You can get in touch with the project team, as well as with the developer community, via the [Croquet Discord](https://croquet.io/discord).
148+
You can get in touch with the project team, as well as with the developer community, via the [Multisynq Discord](https://multisynq.dev/discord).

contributing/git-flow.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)