Skip to content

docs: improve README and CONTRIBUTING for contributors - #14985

Open
skjnldsv wants to merge 3 commits into
masterfrom
feature/improve-readme-contributing
Open

skjnldsv wants to merge 3 commits into
masterfrom
feature/improve-readme-contributing

Conversation

@skjnldsv

@skjnldsv skjnldsv commented May 21, 2026 •

Copy link
Copy Markdown
Member

☑️ Resolves

Makes the README and CONTRIBUTING easier to follow for new contributors.

  • README: new Contributing, Code of Conduct and Getting help sections; the build steps use uv first (it reads .python-version), with a plain venv as fallback; drops the outdated pipenv steps and the "Nightly Automated Build Steps" heading; the PDF Docker image is now ghcr.io/nextcloud/documentation/sphinx-latex:latest.
  • CONTRIBUTING: Code of Conduct at the top, the same uv setup, help links without GitHub Discussions (they are disabled).

🖼️ Screenshots

Before After
README
CONTRIBUTING

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

👾 This pull request was assisted by Claude Code, commits carry an Assisted-by trailer.

@github-actions

github-actions Bot commented May 21, 2026 •

Copy link
Copy Markdown
Contributor

📖 Documentation Preview

🔍 Open preview →

No RST documentation pages changed in this PR.

Last updated: Thu, 15 Oct 2026 14:53:15 GMT

@skjnldsv skjnldsv self-assigned this May 21, 2026
skjnldsv and others added 3 commits October 15, 2026 15:04
- README: restructure with Contributing, CoC, Getting help sections;
  slim contributing block to point to CONTRIBUTING.md; add Talk room
  link; drop GitHub Discussions (disabled); uv as primary build tool
- CONTRIBUTING: add Code of Conduct section; uv as primary setup path,
  plain venv as fallback; update sphinx-autobuild install to use uv

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Replace all em dashes with colons or semicolons throughout README.rst
and CONTRIBUTING.md.

Add `--python 3.13` to uv venv commands with a note that older
stable<N> branches may require a different version.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
master is the next release, Discussions are disabled, uv reads
.python-version, and the structure and spelling rules belong to the
contributing section.

Assisted-by: ClaudeCode:claude-opus-5-5
Signed-off-by: John Molakvoæ <14975046+skjnldsv@users.noreply.github.com>
@skjnldsv
skjnldsv force-pushed the feature/improve-readme-contributing branch from 5ea31ba to ad353b6 Compare October 15, 2026 13:04
@skjnldsv
skjnldsv marked this pull request as ready for review October 15, 2026 13:14
@skjnldsv
skjnldsv requested a review from miaulalala October 15, 2026 13:17
@skjnldsv
skjnldsv enabled auto-merge October 15, 2026 13:17

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant