diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..10adad2e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,103 @@ +# Clone the repository + +git clone cd +gitbot-fleet + +# Using Guix (recommended for reproducibility) + +guix shell -D -f guix.scm + +# Or using toolbox/distrobox + +toolbox create gitbot-fleet-dev toolbox enter gitbot-fleet-dev \# +Install dependencies manually + +# Verify setup + +just check \# or: cargo check / mix compile / etc. just test \# Run test +suite + + + ### Repository Structure + +gitbot-fleet/ ├── src/ \# Source code (Perimeter 1-2) ├── lib/ \# +Library code (Perimeter 1-2) ├── extensions/ \# Extensions (Perimeter 2) +├── plugins/ \# Plugins (Perimeter 2) ├── tools/ \# Tooling (Perimeter +2) ├── docs/ \# Documentation (Perimeter 3) │ ├── architecture/ \# ADRs, +specs (Perimeter 2) │ └── proposals/ \# RFCs (Perimeter 3) ├── examples/ +\# Examples (Perimeter 3) ├── spec/ \# Spec tests (Perimeter 3) ├── +tests/ \# Test suite (Perimeter 2-3) ├── .well-known/ \# Protocol files +(Perimeter 1-3) ├── .github/ \# GitHub config (Perimeter 1) │ ├── +ISSUE_TEMPLATE/ │ └── workflows/ ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md +├── CONTRIBUTING.md \# This file ├── GOVERNANCE.md ├── LICENSE ├── +MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── guix.scm \# Guix +manifest (Perimeter 1) └── Justfile \# Task runner (Perimeter 1) + + + --- + + ## How to Contribute + + ### Reporting Bugs + + **Before reporting**: + 1. Search existing issues + 2. Check if it's already fixed in `main` + 3. Determine which perimeter the bug affects + + **When reporting**: + + Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: + + - Clear, descriptive title + - Environment details (OS, versions, toolchain) + - Steps to reproduce + - Expected vs actual behaviour + - Logs, screenshots, or minimal reproduction + + ### Suggesting Features + + **Before suggesting**: + 1. Check the [roadmap](ROADMAP.md) if available + 2. Search existing issues and discussions + 3. Consider which perimeter the feature belongs to + + **When suggesting**: + + Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: + + - Problem statement (what pain point does this solve?) + - Proposed solution + - Alternatives considered + - Which perimeter this affects + + ### Your First Contribution + + Look for issues labelled: + + - [`good first issue`](https://github.com/hyperpolymath/gitbot-fleet/labels/good%20first%20issue) — Simple Perimeter 3 tasks + - [`help wanted`](https://github.com/hyperpolymath/gitbot-fleet/labels/help%20wanted) — Community help needed + - [`documentation`](https://github.com/hyperpolymath/gitbot-fleet/labels/documentation) — Docs improvements + - [`perimeter-3`](https://github.com/hyperpolymath/gitbot-fleet/labels/perimeter-3) — Community sandbox scope + + --- + + ## Development Workflow + + ### Branch Naming + +docs/short-description \# Documentation (P3) test/what-added \# Test +additions (P3) feat/short-description \# New features (P2) +fix/issue-number-description \# Bug fixes (P2) refactor/what-changed \# +Code improvements (P2) security/what-fixed \# Security fixes (P1-2) + + + ### Commit Messages + + We follow [Conventional Commits](https://www.conventionalcommits.org/): + +(): + +\[optional body\] + +\[optional footer\] diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index b136d2af..00000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,109 +0,0 @@ -== Clone the repository - -git clone https://github.com/hyperpolymath/gitbot-fleet.git cd -gitbot-fleet - -== Using Guix (recommended for reproducibility) - -guix shell -D -f build/guix.scm - -== Or using toolbox/distrobox - -toolbox create gitbot-fleet-dev toolbox enter gitbot-fleet-dev # Install -dependencies manually - -== Verify setup - -just check # or: cargo check / mix compile / etc. just test # Run test -suite - -.... - -### Repository Structure -.... - -gitbot-fleet/ ├── src/ # Source code (Perimeter 1-2) ├── lib/ # Library -code (Perimeter 1-2) ├── extensions/ # Extensions (Perimeter 2) ├── -plugins/ # Plugins (Perimeter 2) ├── tools/ # Tooling (Perimeter 2) ├── -docs/ # Documentation (Perimeter 3) │ ├── architecture/ # ADRs, specs -(Perimeter 2) │ └── proposals/ # RFCs (Perimeter 3) ├── examples/ # -Examples (Perimeter 3) ├── spec/ # Spec tests (Perimeter 3) ├── tests/ # -Test suite (Perimeter 2-3) ├── .well-known/ # Protocol files (Perimeter -1-3) ├── .github/ # GitHub config (Perimeter 1) │ ├── ISSUE_TEMPLATE/ │ -└── workflows/ ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── -CONTRIBUTING.md # This file ├── GOVERNANCE.md ├── LICENSE ├── -MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── guix.scm # Guix -manifest (Perimeter 1) └── Justfile # Task runner (Perimeter 1) - -.... - ---- - -## How to Contribute - -### Reporting Bugs - -**Before reporting**: -1. Search existing issues -2. Check if it's already fixed in `main` -3. Determine which perimeter the bug affects - -**When reporting**: - -Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include: - -- Clear, descriptive title -- Environment details (OS, versions, toolchain) -- Steps to reproduce -- Expected vs actual behaviour -- Logs, screenshots, or minimal reproduction - -### Suggesting Features - -**Before suggesting**: -1. Check the [roadmap](ROADMAP.md) if available -2. Search existing issues and discussions -3. Consider which perimeter the feature belongs to - -**When suggesting**: - -Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include: - -- Problem statement (what pain point does this solve?) -- Proposed solution -- Alternatives considered -- Which perimeter this affects - -### Your First Contribution - -Look for issues labelled: - -- [`good first issue`](https://github.com/hyperpolymath/gitbot-fleet/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/gitbot-fleet/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/gitbot-fleet/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/gitbot-fleet/labels/perimeter-3) — Community sandbox scope - ---- - -## Development Workflow - -### Branch Naming -.... - -docs/short-description # Documentation (P3) test/what-added # Test -additions (P3) feat/short-description # New features (P2) -fix/issue-number-description # Bug fixes (P2) refactor/what-changed # -Code improvements (P2) security/what-fixed # Security fixes (P1-2) - -.... - -### Commit Messages - -We follow [Conventional Commits](https://www.conventionalcommits.org/): -.... - -(): - -{empty}[optional body] - -{empty}[optional footer] diff --git a/bots/echidnabot/README.adoc b/bots/echidnabot/README.adoc index 8d62564d..d2b9d067 100644 --- a/bots/echidnabot/README.adoc +++ b/bots/echidnabot/README.adoc @@ -409,7 +409,7 @@ See link:LICENSE[LICENSE] for details. == Contributing -Contributions welcome! Please see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines. +Contributions welcome! Please see link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md] for guidelines. == Security diff --git a/bots/echidnabot/RELEASE_CHECKLIST.adoc b/bots/echidnabot/RELEASE_CHECKLIST.adoc index 21e23ca4..fbe9dddb 100644 --- a/bots/echidnabot/RELEASE_CHECKLIST.adoc +++ b/bots/echidnabot/RELEASE_CHECKLIST.adoc @@ -83,7 +83,7 @@ cd echidnabot.wiki && git add . && git commit -m "Initial wiki" && git push * [x] README.adoc * [x] ARCHITECTURE.adoc (if present) -* [x] CONTRIBUTING.adoc +* [x] ../../.github/CONTRIBUTING.md * [x] SECURITY.md * [x] CODE_OF_CONDUCT.md diff --git a/bots/echidnabot/RSR_COMPLIANCE.adoc b/bots/echidnabot/RSR_COMPLIANCE.adoc index 95d21553..34b50668 100644 --- a/bots/echidnabot/RSR_COMPLIANCE.adoc +++ b/bots/echidnabot/RSR_COMPLIANCE.adoc @@ -83,6 +83,6 @@ None == References * link:https://github.com/hyperpolymath/RSR-template-repo[RSR Template Repository] -* link:CONTRIBUTING.adoc[Contributing Guidelines] +* link:../../.github/CONTRIBUTING.md[Contributing Guidelines] * link:CODE_OF_CONDUCT.md[Code of Conduct] * link:docs/ARCHITECTURE.adoc[Architecture Documentation]