From 0ff4d90878a396484b0c692e25c012fb8dff1d26 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Fri, 6 Sep 2019 09:45:13 -0400 Subject: [PATCH] docs(contributing): react-vtkjs-viewport, tests --- docs/latest/contributing/index.md | 34 +++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/docs/latest/contributing/index.md b/docs/latest/contributing/index.md index 3e16790fd..5dfc5698c 100644 --- a/docs/latest/contributing/index.md +++ b/docs/latest/contributing/index.md @@ -10,7 +10,15 @@ minimum, you may want to read the following documentation: - [Essentials: Getting Started](./essentials/getting-started.md) - [Advanced: Architecture](./advanced/architecture.md) -### When changes impact multiple repositories +Pull requests that are: + +- Small +- [Well tested](./testing.md) +- Decoupled + +Are much more likely to get reviewed and merged in a timely manner. + +## When changes impact multiple repositories While this can be tricky, we've tried to reduce how often this situation crops up this with our [recent switch to a monorepo][monorepo]. Our maintained @@ -22,7 +30,7 @@ package outside of the monorepo is most common with extension development. Let's demonstrate how to accomplish this with two commonly forked extension dependencies: -#### `cornerstone-tools` +### `cornerstone-tools` On your local file system: @@ -60,9 +68,27 @@ If you wish to stop using your local package, run the following commands in the - `yarn unlink cornerstone-tools` - `yarn install --force` -#### `react-vtkjs-viewport` +### `react-vtkjs-viewport` -... +On your local file system: + +```bash +# code/my-projects/ +. +├── ohif/react-vtkjs-viewport +└── ohif/viewers +``` + +- Open a terminal/shell +- Navigate to `ohif/react-vtkjs-viewport` + - `yarn install` + - [`yarn link`](https://yarnpkg.com/en/docs/cli/link) + - `yarn run start` +- Open a new terminal/shell +- Navigate to `ohif/viewers`. + - `yarn install` + - [`yarn link react-vtkjs-viewport`](https://yarnpkg.com/en/docs/cli/link) + - `yarn run dev` #### Other linkage notes