From f5eafe5fa4ab7519b14c70b45da3bd7ba7131e95 Mon Sep 17 00:00:00 2001 From: Fred Mutabazi <133762699+FREDPENTA5@users.noreply.github.com> Date: Mon, 23 Mar 2026 13:00:35 +0300 Subject: [PATCH 1/2] docs: expand BOS overview and contribution starting point --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 2973e74..1b0c2be 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # BOS BOS (Bugema Operating System) the internet OS! Free, Open Source, Self hostable + +## Overview +BOS (Bugema Operating System) is an open-source project that aims to make self-hosted +web services feel more like an “operating system” for everyday internet usage. + +## Getting Started +At the moment, this repository primarily contains documentation (see `LICENSE` and this +README). A common next step for contributors is to: + +1. Fork the repository. +2. Create a documentation-focused branch (for example: `docs/add-overview`). +3. Add missing sections such as installation/setup instructions, architecture notes, + and contribution guidelines. + +If you add real installation or deployment steps later, please also update this section +to reflect the new workflow. + +## License +MIT License (see `LICENSE`). From e37c3f779693b7a4ffdcffc6387d75a5d4ebc8e8 Mon Sep 17 00:00:00 2001 From: Fred Mutabazi <133762699+FREDPENTA5@users.noreply.github.com> Date: Tue, 21 Apr 2026 12:07:54 +0300 Subject: [PATCH 2/2] docs: improve BOS documentation and add contributing guide --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..89d31e6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to BOS + +Thanks for supporting BOS. + +## Contribution Workflow + +1. Open or select an issue. +2. Fork the repository. +3. Create a branch from `main`: + - `docs/` + - `fix/` + - `feat/` +4. Implement one logical change set. +5. Open a pull request and reference the issue (`Resolves #...`). + +## Pull Request Expectations + +- Clear title and summary +- Why the change matters +- Verification notes +- Linked issue + +## Documentation Standards + +- Prefer concise and actionable sections. +- Keep setup/governance guidance updated when behavior changes. +- Avoid ambiguous language in licensing and contribution policy notes. + +## Code of Conduct (Interim) + +- Be respectful and constructive. +- Assume good intent in reviews. +- Focus feedback on technical quality and project goals. diff --git a/README.md b/README.md index 1b0c2be..c75b949 100644 --- a/README.md +++ b/README.md @@ -17,5 +17,39 @@ README). A common next step for contributors is to: If you add real installation or deployment steps later, please also update this section to reflect the new workflow. +## Quick Start for Contributors + +Because this project is currently documentation-first, the easiest meaningful way to contribute is: + +1. Improve architecture, setup, and governance documentation. +2. Propose implementation milestones through issues. +3. Submit focused pull requests tied to issue numbers. + +### Suggested branch naming +- `docs/...` for documentation work +- `feat/...` for new functional modules +- `fix/...` for corrections + +## Suggested Project Structure (Planned) + +As BOS grows, a structure like the one below can keep work organized: + +```text +BOS/ +├── docs/ # Architecture, setup, roadmap, governance +├── backend/ # Server/API services +├── frontend/ # Web UI +├── deployment/ # Container and infra definitions +├── scripts/ # Utility scripts +├── README.md +└── LICENSE +``` + +## Governance and Sustainability Notes + +- Use issue-driven development to prioritize community needs. +- Keep decisions documented in `docs/` to reduce contributor onboarding time. +- Adopt clear contribution and review guidelines as early as possible. + ## License MIT License (see `LICENSE`).