7f0ad6f84d
* feat: Add initial cli tool structure * feat: add copying template files * feat: Add mode template and command * feat: Add readme template generation * feat: Add documentation to extension template * feat: Enhance documentation of the template mode * fix: cli module type * feat: Add config-based mode and extension registration (#2660) * feat: Add ohif cli add/remove extension/mode (#2661) * Basic working CLI for add-extension and remove-extension * Basic cli for add/remove extension/mode, lots more to do. * Cleanup and harden] * feat: Add list of tasks to add-mode Co-authored-by: Alireza <ar.sedghi@gmail.com> * feat: Add git initialization for the mode or extension template (#2662) * fix: package json file to include templates * feat: Add git initialization for the mode or extension template * feat: Add more checks of git and target dir * feat: refactore library utilities * feat: Add the list command to print extensions and modes (#2664) * feat: Add the list command to print extensions and modes * Add todo * Feat/ohif cli validation + auto install (#2671) * WIP * Working mode keyword verification * Validation * auto install extensions based on modes * WIP remove unused extensions on removeMove * Working add-mode, remove-mode automatic extension management. * If extension is in used by a mode, don't allow the CLI to uninstall it * Cleanup addExtension * cleanup removeExtension and addMode * Cleanup removeMode * Update existing extensions with the needed keywords/peer deps * Fix broken config * Feat/cli search (#2677) * feat: refactor pretty print for console * feat: add search for modes and extensions * fix: ugly colors * Feat/ohif cli error handling publishing (#2679) * WIP * fix: webpack imports * wip * fix: react router dom private routes * from last commit * wip * fix: webpack prod builds * WIP * Working regsitration with new IDs * Stable Co-authored-by: Alireza <ar.sedghi@gmail.com> * verify extensions when constructing modes. (#2681) * verify extensions when constructing modes. * Add version to unit tests so it conforms to schema * Update ohif utils exposed via @ohif/core * Fix import * fix tests * feat: ohif-cli link local modes/extensions for development (#2682) * feat: enable cli to work with project root * feat: add initial link package * feat: add link and unlink extension * feat: add link and unlink mode * erro handling for link-package * feat: add comment on ohif-cli linking for development (#2686) * Docs/ohif cli (#2687) * feat: Add documentation for templates * feat: Add more documentation * Fix/core publish (#2685) * versions * wip * remove webpack clean output * fix publish * use next as dist tag for v3 for now * fix webpack pro recipe for output * fix: lerna publish next * fix(cli): fix issues when trying to link an extension or a mode (#2725) The generated package.json doesn't contain keywords property which is required by the linkPackage function. The module apth wasn't correclty handled too, and when there is no pluginOptions, it fails while reading the file or while generating a default configuration. * make dicom pdf and video work after cli merge * add axios dependency * comment out the chdir for now * create id and version based on user inputs * customizable path for extension and modes * fix template to make the template mode load * fix the questions to loop if path is not desirable * fix templates * correct package json order * unify the package creation for extension and mode * bump versions for each package * bump extension versions to 3.0 * add gitignore to templates * fix version requirements when ^ * update docs * update docs and fix tests * try to fix the tests * bump node version * remove the version from extensions * remove the version from modes * remove version from extensionManager * fix eslint * revert husky version * fix eslint * fix node version for new eslint * fix documentatoin removing version * fix cicle ci image version * fix circle ci node image * fix circle ci node image * add back the video and pdf Co-authored-by: Matthis Duclos <matthis.duclos@gmail.com> Co-authored-by: James A. Petts <jamesapetts@gmail.com>
153 lines
5.0 KiB
Markdown
153 lines
5.0 KiB
Markdown
---
|
|
sidebar_position: 4
|
|
sidebar_label: Contributing
|
|
---
|
|
|
|
# Contributing
|
|
|
|
## How can I help?
|
|
|
|
Fork the repository, make your change and submit a pull request. If you would
|
|
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](/development/getting-started.md)
|
|
- [Architecture](./architecture.md)
|
|
|
|
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
|
|
extensions, ui components, internationalization library, and business logic can
|
|
all be developed by simply running `yarn run dev` from the repository root.
|
|
|
|
Testing the viewer with locally developed, unpublished package changes from a
|
|
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`
|
|
|
|
On your local file system:
|
|
|
|
```bash title="/my-projects/"
|
|
├── cornerstonejs/cornerstone-tools
|
|
└── ohif/viewers
|
|
```
|
|
|
|
- Open a terminal/shell
|
|
- Navigate to `cornerstonejs/cornerstone-tools`
|
|
- `yarn install`
|
|
- [`yarn link`](https://yarnpkg.com/en/docs/cli/link)
|
|
- `yarn run dev`
|
|
|
|
* Open a new terminal/shell
|
|
* 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`
|
|
|
|
As you make changed to `cornerstone-tools`, and it's output is rebuilt, you
|
|
should see the following behavior:
|
|
|
|
|
|
|
|
If you wish to stop using your local package, run the following commands in the
|
|
`ohif/viewers` repository root:
|
|
|
|
- `yarn unlink cornerstone-tools`
|
|
- `yarn install --force`
|
|
|
|
<!--
|
|
### `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
|
|
|
|
We're still working out some of the kinks with local package development as
|
|
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
|
|
code changes can be very time consuming. Please consider the following tips when
|
|
working on your pull requests:
|
|
|
|
- Functionality is appropriate for the repository. Consider creating a GitHub
|
|
issue to discuss your suggested changes.
|
|
- The scope of the pull request is not too large. Please consider separate pull
|
|
requests for each feature as big pull requests are very time consuming to
|
|
understand.
|
|
|
|
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
|
|
|
|
OHIF uses [netlify](https://www.netlify.com/) so that pull requests are
|
|
autogenerated and available for testing.
|
|
|
|
For example, [this url][example-url] allows you to test [pull request 237, the
|
|
request that created this FAQ entry,][pr-237] using data pulled from Amazon S3.
|
|
|
|
Replacing the number 237 in the link below with your pull request number should
|
|
let you test it as well and you can use this link for discussions on github
|
|
without requiring reviewers to download and build your branch.
|
|
|
|
```bash
|
|
https://deploy-preview-237--ohif.netlify.com/viewer/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/sampleDICOM.json
|
|
```
|
|
|
|
If you have made a documentation change, a link like this will let you preview
|
|
the gitbook generated by the pull request:
|
|
|
|
```bash
|
|
https://deploy-preview-237--ohif.netlify.com/contributing.html
|
|
``` -->
|
|
|
|
<!--
|
|
Links
|
|
-->
|
|
|
|
<!-- prettier-ignore-start -->
|
|
[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 -->
|