-
-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(root): relocate the contributing guide into .github/ #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # Clone the repository | ||
|
|
||
| git clone <https://github.com/hyperpolymath/standards.git> cd standards | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: sed -n '1,18p' .github/CONTRIBUTING.mdRepository: hyperpolymath/deed-core Length of output: 535 Separate the clone and The Markdown renders the URL as a link, but git clone https://github.com/hyperpolymath/standards.git
cd standards🤖 Prompt for AI Agents |
||
|
|
||
| # Using Nix (recommended for reproducibility) | ||
|
|
||
| nix develop | ||
|
|
||
| # Or using toolbox/distrobox | ||
|
|
||
| toolbox create standards-dev toolbox enter standards-dev \# Install | ||
| dependencies manually | ||
|
|
||
| # Verify setup | ||
|
|
||
| just check \# or: cargo check / mix compile / etc. just test \# Run test | ||
| suite | ||
|
|
||
|
|
||
| ### Repository Structure | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: sed -n '1,110p' .github/CONTRIBUTING.mdRepository: hyperpolymath/deed-core Length of output: 3391 Remove the unintended four-space indentation from the guide. The indentation starts an indented code block at 🤖 Prompt for AI Agents |
||
|
|
||
| standards/ ├── 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 ├── | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: sed -n '18,38p' .github/CONTRIBUTING.md
find . -maxdepth 2 -iname 'CONTRIBUTING.*' -printRepository: hyperpolymath/deed-core Length of output: 1111 🏁 Script executed: printf '%s\n' '--- tree source ---'
cat -n .github/CONTRIBUTING.md | sed -n '24,36p'
printf '%s\n' '--- tracked paths ---'
git ls-files | grep -E '(^|/)CONTRIBUTING(\.[^/]*)?$|^\.github/'Repository: hyperpolymath/deed-core Length of output: 2113 Correct the repository tree. The tree lists 🧰 Tools🪛 LanguageTool[locale-violation] ~31-~31: LICENSE must be spelled with a “c” when used as a noun in British English. Use “licence”. (LICENCE_LICENSE_NOUN_SINGULAR) 🤖 Prompt for AI Agents |
||
| 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/standards/labels/good%20first%20issue) — Simple Perimeter 3 tasks | ||
| - [`help wanted`](https://github.com/hyperpolymath/standards/labels/help%20wanted) — Community help needed | ||
| - [`documentation`](https://github.com/hyperpolymath/standards/labels/documentation) — Docs improvements | ||
| - [`perimeter-3`](https://github.com/hyperpolymath/standards/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\] | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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) | ||
|
|
@@ -68,9 +68,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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: for f in actions/validate/.github/workflows/rhodibot.yml bindings/deno/.github/workflows/rhodibot.yml bindings/haskell/.github/workflows/rhodibot.yml bindings/rust/.github/workflows/rhodibot.yml; do echo ==== $f; sed -n '24,76p' "$f"; doneRepository: hyperpolymath/deed-core Length of output: 7015 🏁 Script executed: for f in actions/validate/.github/workflows/rhodibot.yml bindings/deno/.github/workflows/rhodibot.yml bindings/haskell/.github/workflows/rhodibot.yml bindings/rust/.github/workflows/rhodibot.yml; do
echo "==== $f"
sed -n '1,140p' "$f"
done
echo "==== CONTRIBUTING.md files"
git ls-files '*CONTRIBUTING.md' '.github/CONTRIBUTING.md' | sort
echo "==== workflow working-directory/defaults references"
rg -n 'working-directory|defaults:|CONTRIBUTING\.md' actions/validate/.github/workflows/rhodibot.yml bindings/deno/.github/workflows/rhodibot.yml bindings/haskell/.github/workflows/rhodibot.yml bindings/rust/.github/workflows/rhodibot.ymlRepository: hyperpolymath/deed-core Length of output: 23970 Run each Rhodibot step from its subproject root. Workspace-root paths would fix only the duplicate check. The step also uses relative paths for file deletion, renaming, SPDX updates, file creation, and issue checks, so it would still operate on checkout-root files. Set 🤖 Prompt for AI Agents |
||
| rm ../../../../.github/CONTRIBUTING.md | ||
| FIXES="$FIXES\n- Deleted duplicate \`../../../../.github/CONTRIBUTING.md\` (keeping .md for GitHub)" | ||
| CHANGED=true | ||
| fi | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ We welcome contributions in many forms: | |
|
|
||
| == Contribution Policies | ||
|
|
||
| For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at link:.github/CONTRIBUTING.md[CONTRIBUTING.adoc]. | ||
| For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at link:.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Update all relocated AsciiDoc link targets. Each changed line updates the visible path but leaves the
📍 Affects 3 files
🤖 Prompt for AI Agents |
||
|
|
||
| == Code of Conduct | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ We welcome contributions in many forms: | |
|
|
||
| == Contribution Policies | ||
|
|
||
| For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at link:.github/CONTRIBUTING.md[CONTRIBUTING.adoc]. | ||
| For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at link:.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md]. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Correct the relative AsciiDoc target in all nested contribution guides. Each link resolves inside its sub-project instead of the repository root. Use
📍 Affects 3 files
🤖 Prompt for AI Agents |
||
|
|
||
| == Code of Conduct | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Update the Security document link.
SECURITY.adocline 412 still links toCONTRIBUTING.mdat the repository root. The relocation deletes that target. Change it to.github/CONTRIBUTING.md.🤖 Prompt for AI Agents