From 201302875d009e3cde530890ba6dc48ee0faf0cd Mon Sep 17 00:00:00 2001 From: Samuel Wein Date: Wed, 11 Mar 2026 11:06:26 +0100 Subject: [PATCH 1/2] Add links to CONTRIBUTING and onboarding, align content with these. --- docs/manual/develop.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/docs/manual/develop.md b/docs/manual/develop.md index 67b8298c..5a773d76 100644 --- a/docs/manual/develop.md +++ b/docs/manual/develop.md @@ -8,6 +8,12 @@ To contribute to OpenMS: For any questions, please [contact us](/about/communication.md). +**New to the project?** Start with our [Contributor Onboarding Guide](https://openms.de/onboarding) to understand project structure and communication channels. + +**Ready to contribute code?** See [CONTRIBUTING.md](https://github.com/OpenMS/OpenMS/blob/develop/CONTRIBUTING.md) for workflow and process guidelines. + +This guide covers technical details for active developers. + ## Technical documentation ```{note} @@ -22,20 +28,9 @@ See the documentation for the [latest release](https://abibuilder.cs.uni-tuebing ## Contribution guidelines -Before contributing to OpenMS, read information on the development model and conventions followed to maintain a coherent -code base. - -### Development model - -OpenMS follows the [Gitflow development workflow](http://nvie.com/posts/a-successful-git-branching-model/). - -Every contributor is encouraged to create their own fork (even if they are eligible to push directly to OpenMS). -To create a fork: +For detailed contribution workflows, pull request checklists, issue reporting guidelines, and OpenMS-specific development processes, see the canonical [CONTRIBUTING.md](https://github.com/OpenMS/OpenMS/blob/develop/CONTRIBUTING.md) in the main repository. -1. Follow the documentation on [forking](https://help.github.com/articles/fork-a-repo). -2. Keep your fork [up-to-date](https://help.github.com/articles/syncing-a-fork). -3. Create a [pull request](https://help.github.com/articles/using-pull-requests). Before opening the pull request, please - view the [pull request guidelines](/manual/contribute/pull-request-checklist.md). +This developer guide focuses on technical implementation details below. ### Coding conventions From ef4a99abcee3551d71b183e5aa367f5c5866061b Mon Sep 17 00:00:00 2001 From: Samuel Wein Date: Thu, 12 Mar 2026 14:00:53 +0100 Subject: [PATCH 2/2] Fix Contributor Onboarding Guide link Updated link for the Contributor Onboarding Guide. --- docs/manual/develop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual/develop.md b/docs/manual/develop.md index 5a773d76..0d3239cd 100644 --- a/docs/manual/develop.md +++ b/docs/manual/develop.md @@ -8,7 +8,7 @@ To contribute to OpenMS: For any questions, please [contact us](/about/communication.md). -**New to the project?** Start with our [Contributor Onboarding Guide](https://openms.de/onboarding) to understand project structure and communication channels. +**New to the project?** Start with our [Contributor Onboarding Guide](https://openms.de/contribute) to understand project structure and communication channels. **Ready to contribute code?** See [CONTRIBUTING.md](https://github.com/OpenMS/OpenMS/blob/develop/CONTRIBUTING.md) for workflow and process guidelines.