diff --git a/docs/latest/contributing.md b/docs/latest/contributing.md index 0402cca4b..f0bd63732 100644 --- a/docs/latest/contributing.md +++ b/docs/latest/contributing.md @@ -10,7 +10,8 @@ Fork the repository, make your change and submit a pull request. - `react-viewerbase`: Reusable React Component Library - `Viewers`: The glue, PWA, and primary extension point - 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? @@ -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 working on your pull requests: -- Functionality is appropriate for the repository. Consider posting on the forum - if you are not sure. -- 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. +- 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. diff --git a/docs/latest/frequently-asked-questions.md b/docs/latest/frequently-asked-questions.md index 4e6734faf..eec5c1a3f 100644 --- a/docs/latest/frequently-asked-questions.md +++ b/docs/latest/frequently-asked-questions.md @@ -4,16 +4,14 @@ We accept and triage bug reports through Github primarily. -1. [Create a Github account](https://github.com/join) -2. Search the current [Issue List](https://github.com/OHIF/Viewers/issues) to - ensure you are not creating a duplicate issue. - -If your issue already exists, post a comment to show us that this issue also -affects you. - -3. If no prior issue exists, - [Create a New Issue](https://github.com/OHIF/Viewers/issues/new) on the - repository. +- [Create a Github account](https://github.com/join) +- Search the current [Issue List](https://github.com/OHIF/Viewers/issues) to + ensure you are not creating a duplicate issue. + - If your issue already exists, post a comment to show us that this issue also + affects you. +- If no prior issue exists, + [Create a New Issue](https://github.com/OHIF/Viewers/issues/new) on the + repository. Some tips for filing a new issue: