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/conative-gating.git> cd
conative-gating

# Using Guix (recommended for reproducibility)

guix develop

# Or using toolbox/distrobox

toolbox create conative-gating-dev toolbox enter conative-gating-dev \#
Install dependencies manually

# Verify setup

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


### Repository Structure

conative-gating/ ├── 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/conative-gating/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/conative-gating/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/conative-gating/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/conative-gating/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\]
2 changes: 1 addition & 1 deletion .hypatia/scan-cache/fix-http-to-https.hashes
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ f874e549510c17410c2759864c5559072dfead364411bb2f3b0095c6b29e5387 src/arbiter/li
101cb742c1cb66b36e740deb89ca53dcf54e754499af88eb07286e9e99298dd4 training/violations/07-licensing.md
3ed27e65b5ce47eeb736ad01b88528ac4c146ab203390dc4020155ea63762893 scripts/deploy-templates.sh
2eea81e69ec8e439776e1c793e364b53ff6fcd2c96f4c2688dad0ffdf37df537 training/violations/05-web-standards.md
07efd5aa99ec74c71ff2dc7ab4a2712d2a4bf7846c4a30ec0842527a0ea44be7 CONTRIBUTING.adoc
07efd5aa99ec74c71ff2dc7ab4a2712d2a4bf7846c4a30ec0842527a0ea44be7 ../../.github/CONTRIBUTING.md
0e9c4d86589e2e26e172af25faccfe3a836dc1d6ed3ba9d2a897a92368498daa docs/STATE_ECOSYSTEM_SCHEMA.adoc
101ace35aa8f4d683d66facabfe2748e73a32a450e20dc3a8598be2a9944c1fa docs/REPO_CONSISTENCY.adoc
38d1ea673c098b105dde769844ac9910b95dad4a5e8633c363a53a98ddff048b CONTRIBUTING.md
Expand Down
109 changes: 0 additions & 109 deletions CONTRIBUTING.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion 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
2 changes: 1 addition & 1 deletion docs/DIRECTORY_STRUCTURE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ docs/
├── man/ # Man pages
│ └── project-name.1 # Main man page
├── ARCHITECTURE.adoc # Technical design (optional)
├── CONTRIBUTING.adoc # Contribution guide
├── ../.github/CONTRIBUTING.md # Contribution guide
├── GOVERNANCE.adoc # Decision-making process
├── just-cookbook.adoc # Auto-generated Justfile docs
├── BADGE_SCHEMA.adoc # Badge documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/REPO_STANDARDIZATION.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ dependabot.yml:: Dependency updates

=== Documentation Files (AsciiDoc)

CONTRIBUTING.adoc:: Contribution guidelines
../.github/CONTRIBUTING.md:: Contribution guidelines
* RSR Policy reference
* TPCF agreement
* Code style requirements
Expand Down
2 changes: 1 addition & 1 deletion docs/REPO_VARIATIONS.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ strategy:
|Usage |VARIES |Examples
|Configuration |VARIES |If applicable
|License |COMMON |Reference to LICENSE.txt
|Contributing |COMMON |Reference to CONTRIBUTING.adoc
|Contributing |COMMON |Reference to ../.github/CONTRIBUTING.md
|===

==== CLAUDE.adoc Content
Expand Down
2 changes: 1 addition & 1 deletion docs/accessibility/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,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

Expand Down
2 changes: 1 addition & 1 deletion scripts/apply-common-files.sh
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ ACTIONEOF
== 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.adoc[Code of Conduct]
REFEOF
log "Added RSR_COMPLIANCE.adoc to $name"
Expand Down
2 changes: 1 addition & 1 deletion templates/RSR_COMPLIANCE.adoc.template
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ This document describes the Rhodium Standard Repository (RSR) compliance status
== 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.adoc[Code of Conduct]
2 changes: 1 addition & 1 deletion templates/rsr-metadata.ncl
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See link:LICENSE[LICENSE] for details.

== Contributing

Contributions welcome. Please read link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] first.
Contributions welcome. Please read link:../.github/CONTRIBUTING.md[../.github/CONTRIBUTING.md] first.

== Metadata

Expand Down
2 changes: 1 addition & 1 deletion training/violations/02-documentation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ____
* [ ] `+README.adoc+` or `+README.md+` - Project description
* [ ] `+LICENSE.txt+` - Clear license
* [ ] `+CODE_OF_CONDUCT.adoc+` - Community standards
* [ ] `+CONTRIBUTING.adoc+` - Contribution guide
* [ ] `+../../.github/CONTRIBUTING.md+` - Contribution guide

=== Compliance Indicators

Expand Down
Loading