TrizTech/ohif-viewer
15
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidying up contribution docs

Browse Source
This commit is contained in:
dannyrb 2019-05-13 13:47:42 -04:00
parent d10710ec51
commit b6d9b9aefc
2 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/latest/contributing.md
View File

@ -10,7 +10,8 @@ Fork the repository, make your change and submit a pull request.
- `react-viewerbase`: Reusable React Component Library - `react-viewerbase`: Reusable React Component Library
- `Viewers`: The glue, PWA, and primary extension point - `Viewers`: The glue, PWA, and primary extension point
- At a minimum, you may want to read the following documentation: - At a minimum, you may want to read the following documentation:
- h - [Essentials: Getting Started](./essentials/getting-started.md)
- [Advanced: Architecture](./advanced/architecture.md)
## Any guidance on submitting changes? ## Any guidance on submitting changes?
@ -18,12 +19,8 @@ While we do appreciate code contributions, triaging and integrating contributed
code changes can be very time consuming. Please consider the following tips when code changes can be very time consuming. Please consider the following tips when
working on your pull requests: working on your pull requests:
- Functionality is appropriate for the repository. Consider posting on the forum - Functionality is appropriate for the repository. Consider creating a GitHub
if you are not sure. issue to discuss your suggested changes.
- Code quality is acceptable. We don't have coding standards defined, but make
sure it passes ESLint and looks like the rest of the code in the repository.
- Quality of design is acceptable. This is a bit subjective so you should
consider posting on the forum for specific guidance.
- The scope of the pull request is not too large. Please consider separate pull - 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 requests for each feature as big pull requests are very time consuming to
understand. understand.

18
docs/latest/frequently-asked-questions.md
View File

@ -4,16 +4,14 @@
We accept and triage bug reports through Github primarily. We accept and triage bug reports through Github primarily.
1. [Create a Github account](https://github.com/join) - [Create a Github account](https://github.com/join)
2. Search the current [Issue List](https://github.com/OHIF/Viewers/issues) to - Search the current [Issue List](https://github.com/OHIF/Viewers/issues) to
ensure you are not creating a duplicate issue. ensure you are not creating a duplicate issue.
- If your issue already exists, post a comment to show us that this issue also
If your issue already exists, post a comment to show us that this issue also affects you.
affects you. - If no prior issue exists,
[Create a New Issue](https://github.com/OHIF/Viewers/issues/new) on the
3. If no prior issue exists, repository.
[Create a New Issue](https://github.com/OHIF/Viewers/issues/new) on the
repository.
Some tips for filing a new issue: Some tips for filing a new issue: