diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..0976694 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,102 @@ +# Clone the repository + +git clone cd defiant + +# Using Guix (recommended for reproducibility) + +guix develop + +# Or using toolbox/distrobox + +toolbox create defiant-dev toolbox enter defiant-dev \# Install +dependencies manually + +# Verify setup + +just check \# or: cargo check / mix compile / etc. just test \# Run test +suite + + + ### Repository Structure + +defiant/ ├── 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 ├── flake.guix \# Guix +flake (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/defiant/labels/good%20first%20issue) — Simple Perimeter 3 tasks + - [`help wanted`](https://github.com/hyperpolymath/defiant/labels/help%20wanted) — Community help needed + - [`documentation`](https://github.com/hyperpolymath/defiant/labels/documentation) — Docs improvements + - [`perimeter-3`](https://github.com/hyperpolymath/defiant/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 97f049d..0000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,108 +0,0 @@ -== Clone the repository - -git clone https://github.com/hyperpolymath/defiant.git cd defiant - -== Using Guix (recommended for reproducibility) - -guix develop - -== Or using toolbox/distrobox - -toolbox create defiant-dev toolbox enter defiant-dev # Install -dependencies manually - -== Verify setup - -just check # or: cargo check / mix compile / etc. just test # Run test -suite - -.... - -### Repository Structure -.... - -defiant/ ├── 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 ├── flake.guix # Guix flake (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/defiant/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://github.com/hyperpolymath/defiant/labels/help%20wanted) — Community help needed -- [`documentation`](https://github.com/hyperpolymath/defiant/labels/documentation) — Docs improvements -- [`perimeter-3`](https://github.com/hyperpolymath/defiant/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/README.adoc b/README.adoc index e3403bc..c86ea3b 100644 --- a/README.adoc +++ b/README.adoc @@ -188,7 +188,7 @@ See link:docs/CITATIONS.adoc[docs/CITATIONS.adoc] for citation formats. == Contributing -See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] (forthcoming). +See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md] (forthcoming). == Metadata diff --git a/ROADMAP.adoc b/ROADMAP.adoc index d1227a9..f23e3d4 100644 --- a/ROADMAP.adoc +++ b/ROADMAP.adoc @@ -96,7 +96,7 @@ toc::[] | Security policy document | ○ Pending -| CONTRIBUTING.adoc +| .github/CONTRIBUTING.md | Contribution guidelines | ○ Pending |=== @@ -252,4 +252,4 @@ toc::[] This roadmap is a living document. Contributions, suggestions, and feedback are welcome. -See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines (forthcoming). +See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md] for guidelines (forthcoming). diff --git a/docs/accessibility/README.adoc b/docs/accessibility/README.adoc index 7415d98..4788416 100644 --- a/docs/accessibility/README.adoc +++ b/docs/accessibility/README.adoc @@ -243,7 +243,7 @@ Burble is committed to: * Supporting screen readers and other assistive technologies * Continuous improvement based on user feedback -We welcome contributions to improve accessibility. See our link:../CONTRIBUTING.adoc[Contributing Guide] for details. +We welcome contributions to improve accessibility. See our link:../../.github/CONTRIBUTING.md[Contributing Guide] for details. == Related Documents