Merge pull request #41 from oss-slu/project-meltshiny

kungfuchicken · web-flow · commit 1b5d2139f1e1 · 2023-11-27T15:37:11.000-05:00
Project meltshiny
diff --git a/.github/PULL_REQUEST_TEMPLATE/new_contributor.md b/.github/PULL_REQUEST_TEMPLATE/new_contributor.md
@@ -0,0 +1,15 @@
+---
+name: New Contributor
+about: Template to add someone as a new contributor.
+title: "[DATE]: [FEATURE NAME]"
+labels: contributor, needs triage
+assignees: octocat
+---
+
+We are excited you want to [become an Open Source with SLU contributor](#21). The success of our projects depends on active involvement. If you want to be recognized as a contributor:
+
+- [ ] Add your name to the list in `docs/about/contributors.md`;
+  - Each entry must include a name;
+  - Each entry may optionally include a link to a GitHub user profile;
+  - Add your entry to the end of the list.
+- [ ] Add a link to merged Pull Request or a closed Issue in an OSS [project](https://oss-slu.github.io/docs/portfolio) to this Pull Request. You can use the autolinked references formats for [issues and pull requests](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests).
diff --git a/docs/about/about.md b/docs/about/about.md
@@ -4,17 +4,17 @@ title: About Us
 custom_edit_url: null
 ---
 
-Open Source with SLU was established to help SLU researchers with their custom software needs and to give students practical software development experience. The program is funded by a grant from Alfred P. Sloan foundation and employs Computer Science graduate students to prototype, design, and deliver open-source software to help SLU researchers and their collaborators worldwide. Undergraduate students enrolled in project-based courses work with Open Source with SLU under the mentorship of our graduate students to contribute to ongoing open source projects.
+Open Source with SLU was established to help SLU researchers with their custom software needs, and to give students practical software development experience. The program is funded by a grant from the Alfred P. Sloan Foundation, and employs Computer Science graduate students to prototype, design, and deliver open-source software to help SLU researchers and their collaborators worldwide. Undergraduate students enrolled in project-based courses work with Open Source with SLU under the mentorship of our graduate students to contribute to ongoing open source projects.
 
 ## Leadership Team
 
 ### Daniel Shown
 
-Daniel Shown is the Program Director of the Open Source with SLU program. He handles the program's daily operations, builds connections with industry partners, works with internal and external clients of the program, guides and supports our graduate students. Daniel's focus is to ensure that the program follows its mission of research support, commitment to open-source, and providing students with relevant software development experience.
+Daniel Shown is the Program Director of the Open Source with SLU program. He handles the program's daily operations, builds connections with industry partners, works with internal and external clients of the program, and guides and supports our graduate students. Daniel's focus is to ensure that the program follows its mission of research support, commitment to open-source, and providing students with relevant software development experience.
 
 ### Kate Holdener, Ph.D.
 
-Kate Holdener is an Assistant Professor of Computer Science at Saint Louis University. Her main focus in the department is on software engineering courses. She founded the open-source software program in an effort to engage more student in open-source development, as a way to give them practical experience during school.
+Kate Holdener is an Assistant Professor of Computer Science at Saint Louis University. Her main focus in the department is on software engineering courses. She founded the open-source software program in an effort to engage more students in open-source development, as a way to give them practical experience during school.
 
 ## Graduate Students
 
@@ -23,6 +23,7 @@ Graduate students are at the heart of our open-sour​ce program. They work with
 ### Current Graduate Assistant Team Leads
 
 - Abhilash Kotha
+- Logan Wyas
 - Ruthvik Mannem
 - Sailikhita Pulijala
 - Yash Kamal Bhatia
@@ -37,12 +38,12 @@ Graduate students are at the heart of our open-sour​ce program. They work with
 
 ## SLU Research Team Leads
 
-Staff from Saint Louis University's Research Computing Group have been key partners, and have even taken on the responsibility of leading teams of undergraduate students.  Their work includes active open source projects being used in academia and research.  Projects involve SLU researchers across campus, regional organizations such as the Taylor Geospatial Institute, Washington University in Saint Louis, Newberry Library, the Jesuit Archives, Missouri Botanical Garden, and the St. Louis Federal Reserve. They are also involved in international open standards groups such as the International Image Interoperability Framework (IIIF) and Open Geospatial Consortium (OGC). This team supports the popular public tools TPEN ([t-pen.org](https://t-pen.org)) and the Rerum ecosystem ([rerum.io](https://rerum.io)).
+Staff from Saint Louis University's Research Computing Group have been key partners, and have even taken on the responsibility of leading teams of undergraduate students. Their work includes active open-source projects being used in academia and research. Projects involve SLU researchers across campus, regional organizations such as the Taylor Geospatial Institute, Washington University in Saint Louis, Newberry Library, the Jesuit Archives, Missouri Botanical Garden, and the St. Louis Federal Reserve. They are also involved in international open standards groups such as the International Image Interoperability Framework (IIIF) and Open Geospatial Consortium (OGC). This team supports the popular public tools TPEN ([t-pen.org](https://t-pen.org)) and the Rerum ecosystem ([rerum.io](https://rerum.io)).
 
 ### Patrick Cuba
 
-Patrick Cuba is the IT Architect for RCG at SLU. His service is focused on consulting and project development, translating research questions into features and helping to accellerate human-driven research. Specifically, he designs, develops, and implements technological solutions for use cases that escape typical vendor solutions, usually because of requirements for sustainability, openness, or customizable encoding. He has a passion for the record of human knowledge, especially supporting controversy, ambiuguity, and attribution.
+Patrick Cuba is the IT Architect for RCG at SLU. His service is focused on consulting and project development, translating research questions into features, and helping to accelerate human-driven research. Specifically, he designs, develops, and implements technological solutions for use cases that escape typical vendor solutions, usually because of requirements for sustainability, openness, or customizable encoding. He has a passion for the record of human knowledge, especially supporting controversy, ambiguity, and attribution.
 
 ### Bryan Haberberger
 
-Bryan Haberberger is the Full Stack Developer for RCG at SLU.  He works in the technology stacks behind various projects, and his focus shifts sprint by sprint.  Simply put, he is a professional developer on campus and a resource for faculty, staff, students and outside collaborators looking for software development expertise, especially in the realm of Web Applications.  In recent years, he has accrued specialized skills with geospatial data on the web and is a member of the Open Geospatial Consortium as well as a IIIF Maps TSG co-chair as part of his commitment to open source technologies.  
+Bryan Haberberger is the Full Stack Developer for RCG at SLU. He works in the technology stacks behind various projects, and his focus shifts sprint by sprint. Simply put, he is a professional developer on campus and a resource for faculty, staff, students, and outside collaborators looking for software development expertise, especially in the realm of Web Applications. In recent years, he has accrued specialized skills with geospatial data on the web and is a member of the Open Geospatial Consortium, as well as an IIIF Maps TSG co-chair, as part of his commitment to open-source technologies.
diff --git a/docs/about/community.md b/docs/about/community.md
@@ -1,22 +1,52 @@
 ---
 id: community
-title: Community Engagement
 custom_edit_url: null
 ---
+
 # Community Partners
 
 ## About
+
 We welcome the participation of anyone interested in contributing to the projects in our portfolio. You can work on open issues on projects in our portfolio, create a new issue, or e-mail us if you want to be more involved.
 
+Join the conversation in the Open Source with SLU [Slack workspace](https://join.slack.com/t/oswslu/shared_invite/zt-24f0qhjbo-NkSfQ4LOg5wXxBdxP4vzfA).
+
+## Overview
+
+* Join our Slack workspace.
+* Contribute changes to an Open Source with SLU project.
+* Add your name to the Contributors list.
+* After making five contributions, you can be added to the `oss-slu` team in GitHub by contacting one of the program staff.
+
+## Getting Startted
+
+The success of our projects depends on active involvement. Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when the Pull Request includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project.
+
+If you want to be recognized as a contributor, your pull request should include your name and a link to the work you have completed on an Open Source with SLU project.
+
+* [ ] Add your name to the list in `docs/about/contributors.md`;
+  * Each entry must include a name;
+  * Each entry may optionally include a link to a GitHub user profile;
+  * Add your entry to the end of the list.
+* [ ] Add a link to an already merged Pull Request or a closed Issue in an OSS [project](https://oss-slu.github.io/docs/portfolio) to your Pull Request. You can use the autolinked references formats for [issues and pull requests](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests).
+
+## Join the `oss-slu` Team
+
+After making five contributions, you can be added to the `oss-slu` team in GitHub by contacting one of the program staff. Send an e-mail to <oss@slu.edu> or a slack message to the current Tech Lead on the project(s) you made contributions to. Include a list of at least five closed Issues and/or merged Pull Requests that you worked on.
+ 
 ## Git
-All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this <a href="https://youtu.be/RGOj5yH7evk">video tutorial</a>, if you are not familiar with these tools.
+
+All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this [video tutorial](https://youtu.be/RGOj5yH7evk), if you are not familiar with these tools.
+
 ## Guidance
+
 When you are ready to contribute code to one of our open-source project, here is the process you should follow:
+
 1. Identify the issue you want to work on and post a comment in this issue, asking the repo maintainer to assign the issue to you.
-2. Crate a fork of our repository. Here is GitHub documentation for how to <a href="https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo">create a fork</a>
-3. Clone your fork of the repository. Here is GitHub documentation for how to <a href="https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository">clone a repository</a>.
+2. Crate a fork of our repository. Here is GitHub documentation for how to [create a fork](https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo)
+3. Clone your fork of the repository. Here is GitHub documentation for how to clone [a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
 4. Follow the developer guide to install project dependencies and run the code.
 5. Make the necessary code changes to resolve the issue. Commit and push your changes frequently. Use meaningful commit messages when committing your code.
 6. Test your changes, verifying that the issue is resolved.
-7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">create a pull request</a>. Make sure to note the issue number that your pull request resolves, and include details of your solution.
+7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). Make sure to note the issue number that your pull request resolves, and include details of your solution.
 8. One of our repository maintaners will review your pull request and will either merge it with the original repo, or request some changes. If changes are requested, go back to step 5 and proceed from there.
diff --git a/docs/about/contributors.md b/docs/about/contributors.md
@@ -0,0 +1,10 @@
+---
+id: contributors
+custom_edit_url: null
+---
+# Contributors
+
+These people have contributed to Open Source with SLU projects. They have been added in (approximately) the order in which they became contributors.
+
+- [Kate Holdener, Ph.D](https://github.com/kate-holdener)
+- [Daniel Shown](https://github.com/kungfuchicken)
diff --git a/docs/about/partners.md b/docs/about/partners.md
@@ -10,37 +10,33 @@ Open Source with SLU welcomes opportunities to partner with community outreach p
 
 ## Capabilities
 
-+ Developing a new generation of workforce: hands-on experiences in software engineering and open source software ecosystems 
-+ Software development & maintenance
-    + AI and ML tools
-    + Web, mobile, and desktop apps
-    + IoT and cyber-physical systems
-+	Research support. 
-    + Idea generation through short-term events.
-    + Innovations by sustained development efforts.
-    + Maintenance of existing software repositories.
-    + Open Scholarship and Open Work strategies.
-+ Open source community and ecosystem building
-+ Research software translation for community and industry impact
+- Developing a new generation of workforce: hands-on experiences in software engineering and open-source software ecosystems
+- Software development & maintenance
+  - AI and ML tools
+  - Web, mobile, and desktop apps
+  - IoT and cyber-physical systems
+- Research support
+  - Idea generation through short-term events
+  - Innovations by sustained development efforts
+  - Maintenance of existing software repositories
+  - Open Scholarship and Open Work strategies
+- Open-source community and ecosystem building
+- Research software translation for community and industry impact
 
 ## Opportunities
 
-+ Exploratory development
-+ Proof of concept
-+ Feasibility studies
-+ Skilled talent
+- Exploratory development
+- Proof of concept
+- Feasibility studies
+- Skilled talent
 
 ## Get Involved
 
-+ Internships
-+ Mentorships
-+ Sponsored events
-+ Partners on projects 
-+ Sponsor student teams
-+ FLOSS thought leadership
-+ Community advisory board 
-+ Industry consortium membership
- 
-
-
-
+- Internships
+- Mentorships
+- Sponsored events
+- Partners on projects
+- Sponsor student teams
+- FLOSS thought leadership
+- Community advisory board
+- Industry consortium membership
diff --git a/docs/about/students.md b/docs/about/students.md
@@ -8,8 +8,8 @@ custom_edit_url: null
 
 ## About
 
-Teams of students form the core of our efforts developing open source software. Our initial program is structured around teams of 2-4 undergraduate Computer Science students enrolled in the capstone course. Each team of undergraduate students has an assigned Tech Lead, usually a Graduate Student and sometimes a faculty or staff member. Regular project deliverables are expected from each team. Many teams work on sustainment of existing software codebases, and sometimes teams work on new projects.
+Teams of students form the core of our efforts developing open-source software. Our initial program is structured around teams of 2-4 undergraduate Computer Science students enrolled in the capstone course. Each team of undergraduate students has an assigned Tech Lead, usually a Graduate Student and sometimes a faculty or staff member. Regular project deliverables are expected from each team. Many teams work on sustainment of existing software codebases, and sometimes teams work on new projects.
 
 ## Guidance
 
-Specific guidance for students working on Open Source with SLU projects goes here... 
+Specific guidance for students working on Open Source with SLU projects is forthcoming...
diff --git a/docs/portfolio.md b/docs/portfolio.md
@@ -22,7 +22,7 @@ We are currently accepting project requests. You can submit your request via thi
 - ![DEER](project_deer/deer_100.jpg) **[Data Entry & Exhibition for Rerum](project_deer/about)** A designer's framework for non-destructive annotation and template rendering for distributed digital resources and collections.
 - **[Drone World](project_droneworld/about)** - DroneWorld is a platform for testing small unmanned aerial systems (sUAS) applications by simulating realistic test scenarios based on specified requirements.
 - [Gallery of Glosses](./project_gallery_of_glosses/about) - Interfaces to view and manage Glosses. 
-- MeltShiny
+- **[MeltShiny](project_meltshiny/about)** - automates the analysis and visualization of DNA melting curves for researchers in chemistry, biology, and genetics..
 - ![Mouser](project_mouser/100x100.png) [**Mouser**](project_mouser/about) - This software is used for tracking the data of animal experiments.
 - **[Pi4Micronaut](project_pi4micronaut/about)** - A Java library crafted for developers who aim to build IoT  applications leveraging the Raspberry Pi platform.
 - **[Rerum Geolocator](project_rerum_geolocator/about)** - The application enables users to enhance discovery and access to digital resources through geographic visualization and annotation.
diff --git a/docs/project_meltshiny/about.md b/docs/project_meltshiny/about.md
diff --git a/docs/project_meltshiny/architecture.png b/docs/project_meltshiny/architecture.png
diff --git a/docs/project_meltshiny/architecture.puml b/docs/project_meltshiny/architecture.puml
