contributing: remove mentions of hypernext/next branches#3
Merged
NicolasCARPi merged 5 commits intomasterfrom Mar 1, 2026
Merged
contributing: remove mentions of hypernext/next branches#3NicolasCARPi merged 5 commits intomasterfrom
NicolasCARPi merged 5 commits intomasterfrom
Conversation
WalkthroughThis pull request shifts repository guidance and CI to treat master as the primary integration branch, updating PR templates, workflow branch filters, contributor/install docs, Docker image tags, and backup documentation clarifications about elabctl excluding configuration files. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 1: Replace the single-line smiley in .github/PULL_REQUEST_TEMPLATE.md
with a full actionable PR template: restore sections for Title/summary, Context
& problem statement, What changed (high-level list), How to test
(manual/automated steps), Related issues/links, Checklist (tests, lint, docs,
changelog), and Reviewers/labels; implement these as markdown headings, optional
<details> blocks and checkbox items so contributors are prompted to include
intent, testing steps, and required checks before requesting review.
In `@docs/contributing/devdoc.md`:
- Around line 35-37: The document has conflicting branch guidance: one section
says PRs target "master" while another recommends "next"; pick the canonical
branch (e.g., "next" for active development or "master" for stable PRs) and make
the text consistent throughout by replacing the alternate branch reference so
both the PR target sentence (the sentence mentioning "The target for Pull
Requests is the `master` branch.") and the earlier line that mentions the `next`
branch match; also ensure the release workflow sentence that references
"release/X.Y" and "patch releases ... cherry-picking ... in `master`" is aligned
with your chosen canonical branch (update "master" to "next" or vice versa) and
keep the release/tagging wording consistent with that choice.
In `@docs/install/backups.md`:
- Line 20: The sentence contains a wording typo: replace the phrase "responsible
from backing up your configuration values" with "responsible for backing up your
configuration values" in the docs text (look for the string "responsible from
backing up" in the backups.md content) so the sentence reads correctly and
preserves the rest of the paragraph and examples (e.g., mentions of SECRET_KEY,
database password/IP, bind-mounted folders, ENV vars).
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/PULL_REQUEST_TEMPLATE.md.github/workflows/codespell.ymldocs/contributing/devdoc.mddocs/contributing/installation.mddocs/install/backups.md
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/contributing/devdoc.md (1)
35-37:⚠️ Potential issue | 🟡 MinorSteady as she goes—one grammar fix remains in release workflow text.
Line 37 should read “bugfix commits,” not “bugfixes commits.”
Proposed fix
-Releases get tagged from a `release/X.Y` branch. And patch releases are built from cherry-picking bugfixes commits in `master`. +Releases get tagged from a `release/X.Y` branch, and patch releases are built by cherry-picking bugfix commits in `master`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/contributing/devdoc.md` around lines 35 - 37, Fix the grammar in the release workflow sentence: locate the sentence that reads "Releases get tagged from a `release/X.Y` branch. And patch releases are built from cherry-picking bugfixes commits in `master`." and change "bugfixes commits" to "bugfix commits" so it reads "patch releases are built from cherry-picking bugfix commits in `master`."
🧹 Nitpick comments (1)
docs/contributing/devdoc.md (1)
260-260: Optional precision: make the clone branch explicit.To keep this doc future-proof, you may explicitly clone
masterin the example.Optional tweak
-git clone https://github.com/elabftw/elabftw +git clone --branch master https://github.com/elabftw/elabftw🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/contributing/devdoc.md` at line 260, Update the example git clone command to explicitly specify the branch (e.g., use "git clone --branch master https://github.com/elabftw/elabftw" or "git clone -b master --single-branch https://github.com/elabftw/elabftw") so the devdoc's clone example is future-proof; replace the existing "git clone https://github.com/elabftw/elabftw" line in the docs/contributing/devdoc.md with the branch-explicit form.
🤖 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/contributing/devdoc.md`:
- Line 10: The caution sentence on line containing "It is possible that the gap
between the current development version and the current stable version will
render this documentation obsolete in parts. As we currently have no versioning
of the doc to match stable releases of eLabFTW. I don't know, just do your
best." is awkward and contains a fragment; replace it with a single clear
sentence that explains potential divergence and lack of doc versioning — for
example: "Because the development branch may diverge from the stable release and
we do not version these docs to match eLabFTW releases, some content may become
outdated; please update documentation when you notice discrepancies." Update the
sentence in docs/contributing/devdoc.md accordingly to remove the fragment and
improve clarity.
---
Duplicate comments:
In `@docs/contributing/devdoc.md`:
- Around line 35-37: Fix the grammar in the release workflow sentence: locate
the sentence that reads "Releases get tagged from a `release/X.Y` branch. And
patch releases are built from cherry-picking bugfixes commits in `master`." and
change "bugfixes commits" to "bugfix commits" so it reads "patch releases are
built from cherry-picking bugfix commits in `master`."
---
Nitpick comments:
In `@docs/contributing/devdoc.md`:
- Line 260: Update the example git clone command to explicitly specify the
branch (e.g., use "git clone --branch master https://github.com/elabftw/elabftw"
or "git clone -b master --single-branch https://github.com/elabftw/elabftw") so
the devdoc's clone example is future-proof; replace the existing "git clone
https://github.com/elabftw/elabftw" line in the docs/contributing/devdoc.md with
the branch-explicit form.
* master: backups: clarify backup of config file (#2)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
Chores