Skip to content

Changes

Page history
Started adding details about how the container environments can be used for development authored by Rob Oakes's avatar Rob Oakes
Hide whitespace changes
Inline Side-by-side
dev.contributing.md
View page @ 42ac6b7f
# How to Help # How to Help
Thank you for your interest in [Sonador](https://sonador.oak-tree.tech)! If you would like to help the project, there are many things you can do. Thank you for your interest in [Sonador](https://sonador.oak-tree.tech)! If you would like to help the project, there are many things you can do.
* **Use the software!** Open source projects exist to solve problems and meet the needs of their users. Sonador exists is to help clinicians, researchers, and developers use medical data to improve human health. Actively using software is one of the best ways to support it, find problems, and limitations. * **Use the software!** Open source projects exist to solve problems and meet the needs of their users. Sonador's puprose is to help clinicians, researchers, and developers use medical data to improve human health. Actively using software is one of the best ways to support it, find problems, and uncover limitations.
* **Work on documentation and support materials.** The more complex a stystem becomes, the more difficult it is to help users understand it, discover capabilities, and use the software to provide value. Because Sonador spans three central pillars of functionality -- [IO](https://sonador.oak-tree.tech/io), [AI](https://sonador.oak-tree.tech/ai), and 3D -- with many interconnected components, there is a lot of material to cover. Guides, technical documentation, how-tos, videos, and more are neeed. * **Work on documentation and support materials.** The more complex a stystem becomes, the more difficult it is to help users understand it, discover capabilities, and use the software to provide value. Because Sonador spans three central pillars of functionality -- [IO](https://sonador.oak-tree.tech/io), [AI](https://sonador.oak-tree.tech/ai), and 3D -- with many interconnected components, there is a lot of material to cover. Guides, technical documentation, how-tos, videos, and more are neeed.
* **Share your knowledge**. Sonador builds on top medical standards (such as [DICOM](https://www.dicomstandard.org/) and [FHIR](https://www.hl7.org/fhir/overview.html)) and well established libraries such as [PyDICOM](https://pydicom.github.io/), [PyVista](https://docs.pyvista.org/version/stable/), [SimpleITK](https://simpleitk.org/). If you have solutions, articles, or guides that utilize Sonador, please reach-out and let us know. We'll link those here and help to promote them amongst the broader community. * **Share your knowledge**. Sonador builds on top medical standards (such as [DICOM](https://www.dicomstandard.org/) and [FHIR](https://www.hl7.org/fhir/overview.html)) and well established libraries such as [PyDICOM](https://pydicom.github.io/), [PyVista](https://docs.pyvista.org/version/stable/), [SimpleITK](https://simpleitk.org/). If you have solutions, articles, or guides that utilize Sonador, please reach-out and let us know. We'll link those here and help to promote them amongst the broader community.
* **Write code.** Writing code for Sonador is not hard, and you don't need permission. The source code is freely available to be cloned and we welcome contributions from outside individuals and organizations. Refer to [Sonador Development](dev.idnex) for additional information on how to get started. * **Write code.** Writing code for Sonador is not hard, and you don't need permission. The source code is freely available to be cloned and we welcome contributions from outside individuals and organizations. Refer to [Sonador Development](dev.idnex) for additional information on how to get started.
...@@ -9,7 +9,7 @@ Thank you for your interest in [Sonador](https://sonador.oak-tree.tech)! If you ...@@ -9,7 +9,7 @@ Thank you for your interest in [Sonador](https://sonador.oak-tree.tech)! If you
## Where to Get Help ## Where to Get Help
Because Sonador is an umbrella project, we use the community forums of the Sonador upstream projects for communication and discussion. The [Oak-Tree Technologies GitLab](https://code.oak-tre.tech) is used for project planning and coordination. [Issues](https://code.oak-tree.tech/groups/oak-tree/medical-imaging/-/issues) and [development milestones](https://code.oak-tree.tech/groups/oak-tree/medical-imaging/-/milestones) are used to track the goals and aims of the project, and to help guide its development. Because Sonador is an umbrella project, we use the community forums of the Sonador upstream projects for communication and discussion. The [Oak-Tree Technologies GitLab](https://code.oak-tre.tech) is used for project planning and coordination. [Issues](https://code.oak-tree.tech/groups/oak-tree/medical-imaging/-/issues) and [development milestones](https://code.oak-tree.tech/groups/oak-tree/medical-imaging/-/milestones) are used to track the goals and aims of the project and to help guide its development.
Orthanc, OHIF, Slicer 3D, and FreeCAD all have active forums that can be used to provide feedback, seek support, and help other users. Sonador specific topics can be found on all of the them and the core developers actively participate in the communities. Orthanc, OHIF, Slicer 3D, and FreeCAD all have active forums that can be used to provide feedback, seek support, and help other users. Sonador specific topics can be found on all of the them and the core developers actively participate in the communities.
......