From 805a857776aa84ede884c6715de50b4fadda80c5 Mon Sep 17 00:00:00 2001 From: neon <18559658+neonsolstice@users.noreply.github.com> Date: Fri, 30 Oct 2026 00:51:26 +0000 Subject: [PATCH] docs: fix contributing guide links Fixes #1994 --- .github/pull_request_template.md | 2 +- docs/CONTRIBUTING.md => CONTRIBUTING.md | 30 ++++++++++++------------- README.md | 4 ++-- docs/COMMUNITY.md | 2 +- docs/DEVELOPMENT.md | 4 ++-- docs/TESTING.md | 2 +- 6 files changed, 22 insertions(+), 22 deletions(-) rename docs/CONTRIBUTING.md => CONTRIBUTING.md (86%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f43488b21..692161805 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -89,6 +89,6 @@ AI assistance is welcome on this project; unreviewed AI output is not. See the - [ ] I disclosed all AI assistance, limitations, and unverified behavior. - [ ] The required tests and `pnpm verify` pass against the evidence commit. - [ ] No unintended files, secrets, personal configuration, or unapproved dependencies are included. -- [ ] I followed the [contribution guidelines](https://github.com/bookorbit/bookorbit/blob/main/docs/CONTRIBUTING.md) and [commit guidelines](https://github.com/bookorbit/bookorbit/blob/main/docs/COMMIT_GUIDELINES.md). +- [ ] I followed the [contribution guidelines](https://github.com/bookorbit/bookorbit/blob/main/CONTRIBUTING.md) and [commit guidelines](https://github.com/bookorbit/bookorbit/blob/main/docs/COMMIT_GUIDELINES.md). diff --git a/docs/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 86% rename from docs/CONTRIBUTING.md rename to CONTRIBUTING.md index 2bdfa54eb..087c313e5 100644 --- a/docs/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,16 +4,16 @@ Thanks for your interest in contributing to BookOrbit. Whether you are fixing a **Companion docs:** -- [DEVELOPMENT.md](DEVELOPMENT.md) - Local setup, architecture, commands, and technical reference. -- [TESTING.md](TESTING.md) - Test architecture, E2E suites, coverage thresholds, and harness details. -- [COMMIT_GUIDELINES.md](COMMIT_GUIDELINES.md) - Commit message format, types, scopes, and examples. -- [LOCALIZATION.md](LOCALIZATION.md) - User-facing copy, ICU messages, Crowdin, and adding languages. +- [DEVELOPMENT.md](docs/DEVELOPMENT.md) - Local setup, architecture, commands, and technical reference. +- [TESTING.md](docs/TESTING.md) - Test architecture, E2E suites, coverage thresholds, and harness details. +- [COMMIT_GUIDELINES.md](docs/COMMIT_GUIDELINES.md) - Commit message format, types, scopes, and examples. +- [LOCALIZATION.md](docs/LOCALIZATION.md) - User-facing copy, ICU messages, Crowdin, and adding languages. --- ## Where to Start -For usage questions, setup help, or community conversations, see the [community guide](COMMUNITY.md). You do not need approval or assignment to ask a question or participate. +For usage questions, setup help, or community conversations, see the [community guide](docs/COMMUNITY.md). You do not need approval or assignment to ask a question or participate. Not sure what to work on? Look for issues tagged with: @@ -36,7 +36,7 @@ The rest of this guide still applies (issue first, PR template, etc.), but expec ## Security Issues -Do **not** open public issues for security vulnerabilities. Use GitHub's [private vulnerability reporting](https://github.com/bookorbit/bookorbit/security/advisories/new) instead. See [SECURITY.md](../.github/SECURITY.md) for details. +Do **not** open public issues for security vulnerabilities. Use GitHub's [private vulnerability reporting](https://github.com/bookorbit/bookorbit/security/advisories/new) instead. See [SECURITY.md](.github/SECURITY.md) for details. --- @@ -93,7 +93,7 @@ If this is your first time: pnpm setup ``` -This handles everything: dependencies, PostgreSQL, migrations, and seed data. See [DEVELOPMENT.md](DEVELOPMENT.md) for prerequisites, manual setup steps, and troubleshooting. +This handles everything: dependencies, PostgreSQL, migrations, and seed data. See [DEVELOPMENT.md](docs/DEVELOPMENT.md) for prerequisites, manual setup steps, and troubleshooting. ### Phase 5: Create Your Branch @@ -118,7 +118,7 @@ Start the dev server and get to work: pnpm dev ``` -Refer to [DEVELOPMENT.md](DEVELOPMENT.md) for architecture details, project structure, database workflows, and conventions. A few ground rules: +Refer to [DEVELOPMENT.md](docs/DEVELOPMENT.md) for architecture details, project structure, database workflows, and conventions. A few ground rules: - **One logical change per PR.** Do not bundle a bug fix with a refactor or unrelated cleanup. - **No unapproved dependencies.** Propose new dependencies in the linked issue first (see [Adding Dependencies](#adding-dependencies)). @@ -132,7 +132,7 @@ BookOrbit uses Vue I18n, with English as the complete source catalog and Crowdin - Do not add the key or an English fallback to any non-English catalog. Target catalogs are intentionally sparse, and missing messages fall back to English at runtime. - Do not create or improve target-language translations in a feature pull request. Translate them in [Crowdin](https://crowdin.com/project/bookorbit); the controlled translation workflow will open a separate PR. - Run `pnpm --filter client validate:locales` after changing `en.json`. -- Read [LOCALIZATION.md](LOCALIZATION.md) before changing ICU plural structure, changing the meaning of an existing message, or adding a language. +- Read [LOCALIZATION.md](docs/LOCALIZATION.md) before changing ICU plural structure, changing the meaning of an existing message, or adding a language. CI rejects edits to existing non-English catalogs in ordinary pull requests. A deliberate new-language setup may add only an empty target catalog until Crowdin export is enabled. @@ -156,7 +156,7 @@ pnpm test If your change touches an area covered by an existing E2E suite, run it locally before pushing: `pnpm run e2e:run -- `. Use `pnpm run e2e:list` to see available suites. -For E2E tests, suite IDs, coverage thresholds, and the test harness, see [TESTING.md](TESTING.md). +For E2E tests, suite IDs, coverage thresholds, and the test harness, see [TESTING.md](docs/TESTING.md). ### Phase 8: Verify Code Quality @@ -171,11 +171,11 @@ Before marking your PR ready for review, run the full quality gate yourself: pnpm verify ``` -See the [Code Quality](DEVELOPMENT.md#code-quality) section in DEVELOPMENT.md for individual commands. +See the [Code Quality](docs/DEVELOPMENT.md#code-quality) section in DEVELOPMENT.md for individual commands. ### Phase 9: Commit Your Work -Follow the format in [COMMIT_GUIDELINES.md](COMMIT_GUIDELINES.md). The short version: +Follow the format in [COMMIT_GUIDELINES.md](docs/COMMIT_GUIDELINES.md). The short version: ``` (): @@ -216,7 +216,7 @@ When creating the PR: assigned. Use the issue for direction before approval. - **Attach end-to-end evidence.** Upload a recording showing the changed behavior through the real client. Ready-for-review PRs without the required evidence will not be reviewed. -- **Disclose AI usage** if applicable. See [AI_POLICY.md](AI_POLICY.md) for the format and expectations. +- **Disclose AI usage** if applicable. See [AI_POLICY.md](docs/AI_POLICY.md) for the format and expectations. ### Phase 11: Respond to Review @@ -278,10 +278,10 @@ If your PR introduces a breaking change (schema, API contract, environment varia ### AI-Assisted Contributions -See [AI_POLICY.md](AI_POLICY.md). The short version: disclose all AI usage in your PR description and make sure you understand every line of the diff. +See [AI_POLICY.md](docs/AI_POLICY.md). The short version: disclose all AI usage in your PR description and make sure you understand every line of the diff. --- ## License -By submitting a contribution, you license it under the [GNU Affero General Public License, version 3 only](../LICENSE), together with the [BookOrbit Additional Terms](../ADDITIONAL_TERMS.md). You represent that you have the authority to grant this license. Copyright in your contribution remains yours. +By submitting a contribution, you license it under the [GNU Affero General Public License, version 3 only](LICENSE), together with the [BookOrbit Additional Terms](ADDITIONAL_TERMS.md). You represent that you have the authority to grant this license. Copyright in your contribution remains yours. diff --git a/README.md b/README.md index e368a4f13..87c964f80 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ A self-hosted library and reading platform for ebooks, PDFs, audiobooks, and com [![App Store](https://img.shields.io/badge/App_Store-download-0D96F6?style=flat-square&logo=appstore&logoColor=white)](https://apps.apple.com/us/app/bookorbit-the-official-app/id6811807346) ![Android coming soon](https://img.shields.io/badge/Android-coming_soon-3DDC84?style=flat-square&logo=android&logoColor=white) [![Crowdin](https://img.shields.io/badge/Crowdin-translate-2E3340?style=flat-square&logo=crowdin&logoColor=white)](https://crowdin.com/project/bookorbit) -[![Contributing](https://img.shields.io/badge/Contributing-guide-orange?style=flat-square&logo=handshake&logoColor=white)](https://github.com/bookorbit/bookorbit/blob/main/docs/CONTRIBUTING.md) +[![Contributing](https://img.shields.io/badge/Contributing-guide-orange?style=flat-square&logo=handshake&logoColor=white)](https://github.com/bookorbit/bookorbit/blob/main/CONTRIBUTING.md) ![BookOrbit dashboard showing reading stats, widgets, and book shelves](docs/images/dashboard-overview.png) @@ -196,7 +196,7 @@ Full documentation lives at **[bookorbit.app](https://bookorbit.app/what-is-book **Contributing** - **Local development**: architecture, first-time setup, running, testing and conventions in [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md). -- **Contributing**: branch naming, test expectations, the PR checklist and commit format in [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md). +- **Contributing**: branch naming, test expectations, the PR checklist and commit format in [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/docs/COMMUNITY.md b/docs/COMMUNITY.md index 3dbc08d10..bc1cdc5c7 100644 --- a/docs/COMMUNITY.md +++ b/docs/COMMUNITY.md @@ -33,4 +33,4 @@ Do not report security vulnerabilities in public issues. Follow the private repo - If a conversation produces actionable work, create a linked bug report or feature request and keep the community conversation available for context. An idea being discussed does not mean it is approved for implementation. - Other inactive issues, including help requests, receive a stale warning after 60 days and close after another 14 days without activity. If help is still needed, leave an update before closure or request reopening afterward. Maintainers can use `pinned` to exempt a topic from stale closure. -Before implementing a change, follow the approval and assignment process in [CONTRIBUTING.md](CONTRIBUTING.md). Those requirements apply to code contributions, not to asking for help or joining a conversation. +Before implementing a change, follow the approval and assignment process in [CONTRIBUTING.md](../CONTRIBUTING.md). Those requirements apply to code contributions, not to asking for help or joining a conversation. diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 1d2c7f502..da3e2f3ab 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -2,7 +2,7 @@ Everything you need to work in this codebase: architecture, setup, workflows, conventions, and commands. -For the contribution process (issues, PRs, review), see [CONTRIBUTING.md](CONTRIBUTING.md). For localization and Crowdin workflow details, see [LOCALIZATION.md](LOCALIZATION.md). For test architecture and E2E suite details, see [TESTING.md](TESTING.md). +For the contribution process (issues, PRs, review), see [CONTRIBUTING.md](../CONTRIBUTING.md). For localization and Crowdin workflow details, see [LOCALIZATION.md](LOCALIZATION.md). For test architecture and E2E suite details, see [TESTING.md](TESTING.md). --- @@ -105,7 +105,7 @@ git clone https://github.com//bookorbit.git cd bookorbit ``` -If you are an external contributor, fork first and clone your fork. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. +If you are an external contributor, fork first and clone your fork. See [CONTRIBUTING.md](../CONTRIBUTING.md) for details. #### Step 2 - Create your environment file diff --git a/docs/TESTING.md b/docs/TESTING.md index 09511df7a..34c89a347 100644 --- a/docs/TESTING.md +++ b/docs/TESTING.md @@ -8,7 +8,7 @@ BookOrbit has three layers of tests: Each layer has a specific job and its own tooling. Do not test the same behavior at multiple layers. -For testing expectations by change type, see [CONTRIBUTING.md](CONTRIBUTING.md). +For testing expectations by change type, see [CONTRIBUTING.md](../CONTRIBUTING.md). For the development setup, see [DEVELOPMENT.md](DEVELOPMENT.md). ---