Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Clone the repository

git clone <https://github.com/hyperpolymath/developer-ecosystem.git> cd
developer-ecosystem

# Using Nix (recommended for reproducibility)

nix develop

# Or using toolbox/distrobox

toolbox create developer-ecosystem-dev toolbox enter
developer-ecosystem-dev \# Install dependencies manually

# Verify setup

just check \# or: cargo check / mix compile / etc. just test \# Run test
suite


### Repository Structure

developer-ecosystem/ ├── 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.nix \# Nix
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/developer-ecosystem/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/developer-ecosystem/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/developer-ecosystem/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/developer-ecosystem/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\]
48 changes: 24 additions & 24 deletions .hypatia/scan-cache/fix-http-to-https.hashes

Large diffs are not rendered by default.

109 changes: 0 additions & 109 deletions CONTRIBUTING.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion ada-ecosystem/ada-loom-registry/.rhodium/WAIVER.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ ada-loom-registry targets Rhodium Silver, not Gold. Gold-level documentation is
**Silver Requirements (Must Complete):**

* ✅ README.adoc (from README.md conversion)
* ✅ CONTRIBUTING.adoc
* ✅ ../../../.github/CONTRIBUTING.md
* ✅ ONBOARDING.adoc
* ✅ ADR framework
* ✅ REVERSIBILITY.adoc
Expand Down
2 changes: 1 addition & 1 deletion ada-ecosystem/ada-loom-registry/.rhodium/compliance.json
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
},
"contributing_guide": {
"status": "compliant",
"details": "CONTRIBUTING.adoc exists"
"details": "../../../.github/CONTRIBUTING.md exists"
},
"carbon_reporting": {
"status": "planned",
Expand Down
2 changes: 1 addition & 1 deletion ada-ecosystem/ada-loom-registry/AI_USAGE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Only 2 Markdown files to convert:
Questions about AI usage:

* Open an issue with label: `ai-transparency`
* See CONTRIBUTING.adoc
* See ../../.github/CONTRIBUTING.md

---

Expand Down
4 changes: 2 additions & 2 deletions ada-ecosystem/ada-loom-registry/PROJECT_STATUS.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -252,14 +252,14 @@ cabal build --with-ghc wasm32-wasi-ghc
**Documentation:** All Rhodium Silver docs complete
* SECURITY.adoc (includes package registry security - may need revision if not a registry)
* PRIVACY.adoc (includes package registry privacy - may need revision if not a registry)
* CONTRIBUTING.adoc, TESTING.adoc (Haskell, Hspec, QuickCheck)
* ../../.github/CONTRIBUTING.md, TESTING.adoc (Haskell, Hspec, QuickCheck)
* CI_CD.adoc (Haskell CI)
* WASM_STATUS.adoc (✅ Ready)

**Community:**
* Repository: `https://github.com/hyperpolymath/ada-loom-registry`
* License: PMPL-1.0
* Contact: See CONTRIBUTING.adoc
* Contact: See ../../.github/CONTRIBUTING.md

**Recommendation:** Rename repository to match actual purpose

Expand Down
2 changes: 1 addition & 1 deletion ada-ecosystem/ada-loom-registry/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ just lint # Run hlint
|link:docs/adr/[docs/adr/]
|Architecture Decision Records

|link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]
|link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]
|Contribution guidelines

|link:SECURITY.adoc[SECURITY.adoc]
Expand Down
2 changes: 1 addition & 1 deletion ada-ecosystem/ada-loom-registry/ROADMAP.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ The current repository name `ada-loom-registry` does not reflect the project's p

== Contributing

See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for how to contribute to this roadmap.
See link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md] for how to contribute to this roadmap.

Priority areas for contribution:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
echo "LICENSE: OK"
- name: Check CONTRIBUTING exists
run: |
if [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ]; then
if [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ]; then
echo "::error::CONTRIBUTING file is required for OpenSSF Best Practices"
exit 1
fi
Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:

# Collect all required files that exist
for f in SECURITY.md SECURITY.adoc .github/SECURITY.md LICENSE LICENSE.txt \
CONTRIBUTING.md CONTRIBUTING.adoc README.md README.adoc \
CONTRIBUTING.md ../../../../.github/CONTRIBUTING.md README.md README.adoc \
.machine_readable/STATE.a2ml .machine_readable/META.a2ml \
.machine_readable/ECOSYSTEM.a2ml CHANGELOG.md CHANGELOG.adoc; do
[ -f "$f" ] && REQUIRED_FILES="$REQUIRED_FILES $f"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# rhodibot.yml — Automated RSR compliance enforcement
#
# Reads root-hygiene rules and auto-fixes what it can:
# - Delete banned files (AI.djot, duplicate CONTRIBUTING.adoc, stale snapshots)
# - Delete banned files (AI.djot, duplicate ../../../../.github/CONTRIBUTING.md, stale snapshots)
# - Rename misnamed files (AI.a2ml → 0-AI-MANIFEST.a2ml)
# - Fix SPDX headers (AGPL → PMPL in dotfiles)
# - Create missing required files (SECURITY.md, CONTRIBUTING.md)
Expand Down Expand Up @@ -63,9 +63,9 @@ jobs:
fi

# --- 3. Delete duplicate format files ---
if [ -f "CONTRIBUTING.md" ] && [ -f "CONTRIBUTING.adoc" ]; then
rm CONTRIBUTING.adoc
FIXES="$FIXES\n- Deleted duplicate \`CONTRIBUTING.adoc\` (keeping .md for GitHub)"
if [ -f "CONTRIBUTING.md" ] && [ -f "../../../../.github/CONTRIBUTING.md" ]; then
rm ../../../../.github/CONTRIBUTING.md
FIXES="$FIXES\n- Deleted duplicate \`../../../../.github/CONTRIBUTING.md\` (keeping .md for GitHub)"
CHANGED=true
fi

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
fi
- name: Check CONTRIBUTING exists
run: |
if [ ! -f "CONTRIBUTING.md" ] && [ ! -f "CONTRIBUTING.adoc" ]; then
if [ ! -f "CONTRIBUTING.md" ] && [ ! -f "../../../../.github/CONTRIBUTING.md" ]; then
echo "::error::CONTRIBUTING file is required for OpenSSF Best Practices"
exit 1
fi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ These are housekeeping items, not blockers.

### no-duplicate-contributing
- description: Only one CONTRIBUTING format (keep .md)
- run: "! (test -f CONTRIBUTING.md && test -f CONTRIBUTING.adoc)"
- run: "! (test -f CONTRIBUTING.md && test -f ../../../../../.github/CONTRIBUTING.md)"
- severity: warning

### no-duplicate-readme
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ AffineScript-Vite/
├── README.adoc # High-level pitch — excitement and awe (Rich Human)
├── EXPLAINME.adoc # Developer deep-dive — how it works (Rich Nerd)
├── ROADMAP.adoc # Future direction
├── CONTRIBUTING.adoc # Human contribution guide
├── ../../.github/CONTRIBUTING.md # Human contribution guide
├── GOVERNANCE.adoc # Decision-making model
├── Justfile # Task runner
├── Containerfile # OCI build
Expand Down
2 changes: 1 addition & 1 deletion affinescript-ecosystem/affinescript-vite/Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ verify:

check_either "SECURITY.md" "SECURITY.adoc"
check_file "LICENSE"
check_either "CONTRIBUTING.md" "CONTRIBUTING.adoc"
check_either "CONTRIBUTING.md" "../../.github/CONTRIBUTING.md"
check_either "README.adoc" "README.md"
check_file ".machine_readable/STATE.a2ml"
check_file ".machine_readable/META.a2ml"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# rhodibot.yml — Automated RSR compliance enforcement
#
# Reads root-hygiene rules and auto-fixes what it can:
# - Delete banned files (AI.djot, duplicate CONTRIBUTING.adoc, stale snapshots)
# - Delete banned files (AI.djot, duplicate ../../../../.github/CONTRIBUTING.md, stale snapshots)
# - Rename misnamed files (AI.a2ml → 0-AI-MANIFEST.a2ml)
# - Fix SPDX headers (AGPL → PMPL in dotfiles)
# - Create missing required files (SECURITY.md, CONTRIBUTING.md)
Expand Down Expand Up @@ -63,9 +63,9 @@ jobs:
fi

# --- 3. Delete duplicate format files ---
if [ -f "CONTRIBUTING.md" ] && [ -f "CONTRIBUTING.adoc" ]; then
rm CONTRIBUTING.adoc
FIXES="$FIXES\n- Deleted duplicate \`CONTRIBUTING.adoc\` (keeping .md for GitHub)"
if [ -f "CONTRIBUTING.md" ] && [ -f "../../../../.github/CONTRIBUTING.md" ]; then
rm ../../../../.github/CONTRIBUTING.md
FIXES="$FIXES\n- Deleted duplicate \`../../../../.github/CONTRIBUTING.md\` (keeping .md for GitHub)"
CHANGED=true
fi

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ These are housekeeping items, not blockers.

### no-duplicate-contributing
- description: Only one CONTRIBUTING format
- run: "! (test -f CONTRIBUTING.md && test -f CONTRIBUTING.adoc)"
- run: "! (test -f CONTRIBUTING.md && test -f ../../../../../.github/CONTRIBUTING.md)"
- severity: warning

### no-duplicate-readme
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ These are hard requirements — CI fails if any check fails.
- severity: critical

### contributing
- description: CONTRIBUTING.adoc must exist
- run: test -f CONTRIBUTING.adoc || test -f CONTRIBUTING.md
- description: ../../../../../.github/CONTRIBUTING.md must exist
- run: test -f ../../../../../.github/CONTRIBUTING.md || test -f CONTRIBUTING.md
- severity: warning

### editorconfig
Expand Down
Loading
Loading