Tidying up contribution docs

This commit is contained in:
dannyrb committed 2019-05-13 13:47:42 -04:00
1 parent d10710ec51
commit b6d9b9aefc
2 files changed
+12 -17

No files matched your search

+4 -7
View File
@@ -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.