moved v3 docs

This commit is contained in:
Alireza committed 2021-06-15 19:14:37 -04:00
1 parent 1d281f7033
commit 188d2c75b4
191 files changed
+1507 -6020

No files matched your search

+26 -18
View File
@@ -1,7 +1,3 @@
---
sidebar_position: 2
title: Contributing
---
# Contributing
## How can I help?
@@ -11,8 +7,8 @@ like to discuss the changes you intend to make to clarify where or how they
should be implemented, please don't hesitate to create a new issue. At a
minimum, you may want to read the following documentation:
- [Getting Started](./getting-started.md)
- [Architecture](../architecture/index.md)
- [Getting Started](/development/getting-started.md)
- [Architecture](/architecture/index.md)
Pull requests that are:
@@ -38,7 +34,8 @@ dependencies:
On your local file system:
```bash title="/my-projects/"
```bash
# code/my-projects/
.
├── cornerstonejs/cornerstone-tools
└── ohif/viewers
@@ -46,11 +43,13 @@ On your local file system:
- Open a terminal/shell
- Navigate to `cornerstonejs/cornerstone-tools`
- `npm install`
- `yarn install`
- [`yarn link`](https://yarnpkg.com/en/docs/cli/link)
- `npm run dev`
- `yarn run dev`
- Open a new terminal/shell
- Navigate to `ohif/viewers`.
- Navigate to `ohif/viewers` (the root of ohif project)
- `yarn install`
- [`yarn link cornerstone-tools`](https://yarnpkg.com/en/docs/cli/link)
- `yarn run dev`
@@ -58,10 +57,12 @@ On your local file system:
As you make changed to `cornerstone-tools`, and it's output is rebuilt, you
should see the following behavior:
![example of linked cornerstone-tools package](../assets/img/cornerstone-tools-link.gif)
<div style="text-align: center;">
<a href="/assets/img/cornerstone-tools-link.gif">
<img src="/assets/img/cornerstone-tools-link.gif" alt="Example of linked cornerstone-tools package" style="margin: 0 auto; max-width: 500px;" />
</a>
<div><i>example of linked cornerstone-tools package</i></div>
</div>
If you wish to stop using your local package, run the following commands in the
`ohif/viewers` repository root:
@@ -69,11 +70,13 @@ 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`
On your local file system:
```bash title="/my-projects/"
```bash
# code/my-projects/
.
├── ohif/react-vtkjs-viewport
└── ohif/viewers
@@ -88,7 +91,7 @@ On your local file system:
- Navigate to `ohif/viewers`.
- `yarn install`
- [`yarn link react-vtkjs-viewport`](https://yarnpkg.com/en/docs/cli/link)
- `yarn run dev`
- `yarn run dev` -->
#### Other linkage notes
@@ -97,6 +100,10 @@ there are a lot of factors that can influence the behavior of our development
server and bundler. If you encounter issues not addressed here, please don't
hesitate to reach out on GitHub.
Sometimes you might encounter a situation where the linking doesn't work as expected.
This might happen when there are multiple linked packages with the same name.
You can [remove][unlink] the linked packages inside yarn and try again.
## Any guidance on submitting changes?
While we do appreciate code contributions, triaging and integrating contributed
@@ -112,7 +119,7 @@ working on your pull requests:
We will provide feedback on your pull requests as soon as possible. Following
the tips above will help ensure your changes are reviewed.
## Testing contribution pull requests
<!-- ## Testing contribution pull requests
OHIF uses [netlify](https://www.netlify.com/) so that pull requests are
autogenerated and available for testing.
@@ -133,7 +140,7 @@ the gitbook generated by the pull request:
```bash
https://deploy-preview-237--ohif.netlify.com/contributing.html
```
``` -->
<!--
Links
@@ -143,4 +150,5 @@ https://deploy-preview-237--ohif.netlify.com/contributing.html
[example-url]: https://deploy-preview-237--ohif.netlify.com/viewer/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/sampleDICOM.json
[pr-237]: https://github.com/OHIF/Viewers/pull/237
[monorepo]: https://github.com/OHIF/Viewers/issues/768
[unlink]: https://stackoverflow.com/questions/58459698/is-there-a-command-to-unlink-all-yarn-packages-yarn-unlink-all
<!-- prettier-ignore-end -->