Browse Source

docs: require companion docs PRs for user-visible changes

maziggy 1 month ago
parent
commit
4c27ee680b
2 changed files with 58 additions and 1 deletions
  1. 19 1
      .github/PULL_REQUEST_TEMPLATE.md
  2. 39 0
      CONTRIBUTING.md

+ 19 - 1
.github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,25 @@
 <!-- Link to the issue this PR addresses (if applicable) -->
 <!-- Link to the issue this PR addresses (if applicable) -->
 Fixes #
 Fixes #
 
 
+## Documentation
+
+<!--
+If this PR changes user-visible behavior, config keys, ports, CLI flags,
+URLs, or installation steps, link matching PRs in the docs repos below.
+Internal refactors, bug fixes with no observable change, and test-only
+changes are exempt — just check the "not required" box and say why.
+
+See CONTRIBUTING.md → Documentation Requirements for the full rules.
+-->
+
+**Companion docs PRs** (delete lines that don't apply):
+- Wiki: maziggy/bambuddy-wiki#___
+- Website: maziggy/bambuddy-website#___
+
+**Pick one**:
+- [ ] Docs PR(s) linked above
+- [ ] No docs update required — reason: ___
+
 ## Type of Change
 ## Type of Change
 
 
 <!-- Mark the relevant option with an "x" -->
 <!-- Mark the relevant option with an "x" -->
@@ -42,7 +61,6 @@ Fixes #
 
 
 - [ ] My code follows the project's coding style
 - [ ] My code follows the project's coding style
 - [ ] I have commented my code where necessary
 - [ ] I have commented my code where necessary
-- [ ] I have updated the documentation (if needed)
 - [ ] My changes generate no new warnings
 - [ ] My changes generate no new warnings
 - [ ] I have tested my changes thoroughly
 - [ ] I have tested my changes thoroughly
 
 

+ 39 - 0
CONTRIBUTING.md

@@ -6,6 +6,7 @@ Thank you for your interest in contributing to Bambuddy! This document provides
 
 
 - [Code of Conduct](#code-of-conduct)
 - [Code of Conduct](#code-of-conduct)
 - [Before You Start](#before-you-start)
 - [Before You Start](#before-you-start)
+- [Documentation Requirements](#documentation-requirements)
 - [Getting Started](#getting-started)
 - [Getting Started](#getting-started)
 - [Development Setup](#development-setup)
 - [Development Setup](#development-setup)
 - [Making Changes](#making-changes)
 - [Making Changes](#making-changes)
@@ -35,6 +36,44 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our com
 
 
 This keeps everyone on the same page, avoids wasted effort on changes that may not fit the project's direction, and prevents multiple contributors from working on the same thing.
 This keeps everyone on the same page, avoids wasted effort on changes that may not fit the project's direction, and prevents multiple contributors from working on the same thing.
 
 
+## Documentation Requirements
+
+Features and user-visible behavior changes **must** include matching documentation updates in the docs repos:
+
+- **[bambuddy-wiki](https://github.com/maziggy/bambuddy-wiki)** — end-user guide (installation, configuration, feature walkthroughs, reference)
+- **[bambuddy-website](https://github.com/maziggy/bambuddy-website)** — marketing site (updated only when the change affects public claims or feature lists)
+
+### When docs updates are required
+
+| Change | Needs wiki? | Needs website? |
+|---|---|---|
+| New feature | ✅ | Maybe (if in the feature list) |
+| New config key / setting | ✅ | ❌ |
+| New port, URL, API endpoint | ✅ | ❌ |
+| Installation or upgrade steps change | ✅ | ✅ |
+| UI change that affects screenshots | ✅ | ❌ |
+| Bug fix with no observable behavior change | ❌ | ❌ |
+| Internal refactor | ❌ | ❌ |
+| Test-only change | ❌ | ❌ |
+
+### Workflow
+
+1. Open your code PR here in `bambuddy`
+2. Open companion PR(s) in `bambuddy-wiki` and/or `bambuddy-website`
+3. **Link the companion PR(s) in the code PR description** (the PR template has a dedicated section)
+4. Review the Cloudflare Pages **preview URLs** (posted as comments on the docs PRs) before merging
+5. Merge the PRs together — usually code first, then docs, unless the docs reference new things that don't exist yet
+
+If your change truly doesn't need docs (internal refactor, silent bug fix), say so in the PR description and give a one-line reason.
+
+### Editing docs without a local clone
+
+Both docs repos can be edited directly in the browser, no `git clone` required:
+
+- **GitHub web editor** — click the pencil icon on any file in the repo
+- **github.dev** — press `.` (period) on any repo page to open VS Code in your browser, with multi-file editing and syntax highlighting
+- **Cloudflare Pages previews** — every PR gets a live preview URL auto-posted to the PR as a comment; click it to see your changes rendered on the real site
+
 ## Getting Started
 ## Getting Started
 
 
 1. **Fork the repository** on GitHub
 1. **Fork the repository** on GitHub