-
Notifications
You must be signed in to change notification settings - Fork 27
Description
Read Existing Documentation
I have checked the following places for the error:
Create OpenMS Bug Report
I have created the bug report in OpenMS for any pipeline errors.
Description of the documentation bug
The CONTRIBUTING.md file directs new contributors to ask questions on Gitter:
"For any questions, drop us a ping in OpenMS Gitter"
Link: https://gitter.im/OpenMS/OpenMS
Gitter was officially shut down on 23 December 2023 and migrated to
Element/Matrix. New contributors who follow this link will either land on
a defunct page or find an inactive/confusing platform. This is particularly
harmful for first-time contributors and Hacktoberfest participants who rely
on the CONTRIBUTING.md as their primary onboarding guide.
- I have attached screenshots of the incorrect documentation
📸 Screenshot: Navigate to
.github/CONTRIBUTING.mdand observe the
Gitter link under the "Create a Pull Request" section intro paragraph.
Affected file:
https://github.com/OpenMS/OpenMS-docs/blob/develop/.github/CONTRIBUTING.md
Expected behaviour
The Gitter link should be replaced with a link to an active, maintained
community channel where contributors can actually get help. Suggested
replacements:
- ✅ GitHub Discussions —
already on GitHub, zero friction for contributors - ✅ Element/Matrix room — if OpenMS migrated its Gitter community there
- ✅ OpenMS mailing list or forum — if preferred by maintainers
The updated line in CONTRIBUTING.md should read something like:
"For any questions, start a discussion in
OpenMS GitHub Discussions."
OpenMS Installation
- Version: 3.5.0
Additional context
- Gitter shutdown announcement: https://blog.gitter.im/2023/12/21/gitter-is-shutting-down/
- This affects the primary onboarding file for all new documentation
contributors - The repo is tagged with
hacktoberfest, meaning many first-time open
source contributors will hit this dead link during October events - Fix is a one-line change in
.github/CONTRIBUTING.md— great
good first issuecandidate