From 620a98aa9bf0599d7c65f98b73f60bd55df6b0d1 Mon Sep 17 00:00:00 2001 From: Vasilito Date: Wed, 15 Apr 2026 12:57:07 +0100 Subject: [PATCH] Refresh contributor and status guides Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus --- CONTRIBUTING.md | 28 +++++++++++++++++++++++++++- HARDWARE.md | 9 +++++++++ INTEGRATION_REPORT.md | 8 ++++++++ 3 files changed, 44 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a365310..fa16895b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,31 @@ By sending a message in the room, your MR will not be forgotten or accumulate co You can read the best practices and guidelines on the [Best practices and guidelines](https://doc.redox-os.org/book/best-practices.html) chapter. +## Repository Model for Contributors + +RedBearOS should be treated as an overlay distribution on top of Redox, in the same way Ubuntu +relates to Debian. + +That means contributors should keep this separation in mind: + +- upstream-owned trees such as `recipes/*/source/` are refreshable working copies, +- durable Red Bear-specific work belongs in `local/patches/`, `local/recipes/`, `local/docs/`, and + tracked Red Bear configs, +- if a change exists only in an upstream-owned source tree, it is not yet preserved properly for + long-term Red Bear maintenance. + +### WIP rule for contributors + +If an upstream recipe or subsystem is still marked WIP, Red Bear treats it as a local project until +upstream promotes it to first-class status. + +So for contributors: + +- upstream WIP may still be a useful input/reference, +- but fixes intended for Red Bear shipping should normally land in the Red Bear overlay, +- and when upstream later catches up, Red Bear should prefer upstream and retire local patches or + local recipe copies that are no longer needed. + ## Development Recommendations and Tips - Copy-paste prevent and reduce typos @@ -166,7 +191,8 @@ If you don't know how to code in Rust but know other programming languages: - Web development on the website (we only accept minimal JavaScript code to preserve performance) - Write unit tests (may require minimal knowledge of Rust) -- Port C/C++ programs to Redox (read the `TODO`s of the recipes on the [WIP category](https://gitlab.redox-os.org/redox-os/redox/-/tree/master/recipes/wip)) +- Port C/C++ programs to Redox (read upstream WIP `TODO`s as inputs, but do not assume upstream WIP + recipes are automatically the durable Red Bear shipping source of truth) - Port programs to Redox If you know how to code in Rust but don't know operating system development: diff --git a/HARDWARE.md b/HARDWARE.md index 853db42c..0110e99e 100644 --- a/HARDWARE.md +++ b/HARDWARE.md @@ -1,9 +1,18 @@ # Hardware Compatibility > Hardware compatibility inherited from upstream Redox OS. See https://doc.redox-os.org/book/hardware-support.html for the latest upstream data. +> +> **Status note (2026-04-15):** This file is a hardware-reporting/support-tracking surface, not the +> canonical source for profile support language or project execution order. For current Red Bear +> support framing, also use `docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md` and +> `local/docs/PROFILE-MATRIX.md`. This document tracks the current hardware compatibility of Red Bear OS. +Red Bear OS should now treat AMD and Intel machines as equal-priority hardware targets. Older +AMD-first wording in subsystem roadmap documents should be read as historical sequencing rather +than current platform policy. + - [Why are hardware reports needed?](#why-are-hardware-reports-needed) - [What if my computer is customized?](#what-if-my-computer-is-customized) - [Status](#status) diff --git a/INTEGRATION_REPORT.md b/INTEGRATION_REPORT.md index e1a0601b..c465aa7a 100644 --- a/INTEGRATION_REPORT.md +++ b/INTEGRATION_REPORT.md @@ -9,6 +9,14 @@ > that this report still describes as missing, including `redox-driver-sys`, `linux-kpi`, > `firmware-loader`, `redox-drm`, the AMD display path, the Qt6 stack, `config/redbear-kde.toml`, > and a large `local/recipes/kde/` tree. +> +> **Canonical current-state docs:** use `README.md`, `AGENTS.md`, and +> `docs/07-RED-BEAR-OS-IMPLEMENTATION-PLAN.md` for repository-level current truth. For subsystem +> current-state detail, use the active documents under `local/docs/`. +> +> **WIP interpretation note:** upstream `recipes/wip/...` paths referenced below are part of the +> historical assessment context and should not be read as automatic current Red Bear shipping source +> of truth. Apply the overlay/WIP policy and the WIP migration ledger when interpreting them. ## Current Snapshot