Skip to content

Add links to CONTRIBUTING and onboarding, align content with these.#267

Open
poshul wants to merge 2 commits intodevelopfrom
update_developers_guide
Open

Add links to CONTRIBUTING and onboarding, align content with these.#267
poshul wants to merge 2 commits intodevelopfrom
update_developers_guide

Conversation

@poshul
Copy link
Collaborator

@poshul poshul commented Mar 11, 2026

Merge after:

OpenMS/OpenMS-website#253

Summary by CodeRabbit

  • Documentation
    • Streamlined the developer guide by centralizing contribution workflow details in a single, canonical reference.
    • Replaced legacy development model guidance with a clear pointer to the canonical CONTRIBUTING material.
    • Clarified that the guide focuses on technical implementation details for active developers and linked onboarding/contributor resources for new contributors.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 80f5551e-ca61-4c65-b478-f731c573e742

📥 Commits

Reviewing files that changed from the base of the PR and between 2013028 and ef4a99a.

📒 Files selected for processing (1)
  • docs/manual/develop.md

📝 Walkthrough

Walkthrough

Updated developer documentation: removed detailed Gitflow/forking and PR procedures, added explicit links to Contributor Onboarding Guide and canonical CONTRIBUTING.md, and clarified the guide focuses on technical implementation details for active developers.

Changes

Cohort / File(s) Summary
Documentation Update
docs/manual/develop.md
Removed detailed development model (Gitflow, forking, PR guidance); added links to Contributor Onboarding Guide and canonical CONTRIBUTING.md; added line stating the guide covers technical details for active developers.

Poem

🐇 I hopped through docs to tidy the trail,
Trimmed the branches where details prevail,
Pointed the way to one CONTRIBUTING tree,
Clearer paths for devs — hop on with me!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding links to CONTRIBUTING and onboarding resources while aligning documentation content with these resources.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update_developers_guide

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/manual/develop.md (1)

15-15: Trim one of these two intro sentences.

Line 15 and Line 33 are effectively saying the same thing, so keeping both feels redundant. I’d keep one and drop the other to make the page read cleaner.

Also applies to: 33-33

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/manual/develop.md` at line 15, Remove the duplicated intro sentence:
locate the sentence "This guide covers technical details for active developers."
and the near-duplicate later in the document and delete one of them so only a
single concise intro remains; ensure the remaining sentence reads naturally with
the paragraph that follows and update surrounding whitespace/punctuation if
needed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/manual/develop.md`:
- Around line 11-13: The new onboarding URL in docs/manual/develop.md
("Contributor Onboarding Guide" linking to https://openms.de/onboarding) points
to a page that doesn't yet exist; remove or replace that dead link: either
remove the hyperlink and keep plain text, or swap the href to an existing URL
(e.g., a current onboarding page or the repository's CONTRIBUTING.md) so the
"Contributor Onboarding Guide" link resolves; update the link text/URL in the
lines containing "Contributor Onboarding Guide" and
"https://openms.de/onboarding" accordingly.

---

Nitpick comments:
In `@docs/manual/develop.md`:
- Line 15: Remove the duplicated intro sentence: locate the sentence "This guide
covers technical details for active developers." and the near-duplicate later in
the document and delete one of them so only a single concise intro remains;
ensure the remaining sentence reads naturally with the paragraph that follows
and update surrounding whitespace/punctuation if needed.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a1909538-a30e-4d0c-b10a-8171d8366434

📥 Commits

Reviewing files that changed from the base of the PR and between d412601 and 2013028.

📒 Files selected for processing (1)
  • docs/manual/develop.md

Updated link for the Contributor Onboarding Guide.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant