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

# Using Nix (recommended for reproducibility)

nix develop

# Or using toolbox/distrobox

toolbox create reposystem-dev toolbox enter reposystem-dev \# Install
dependencies manually

# Verify setup

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


### Repository Structure

reposystem/ ├── 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/reposystem/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/reposystem/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/reposystem/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/reposystem/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\]
108 changes: 0 additions & 108 deletions CONTRIBUTING.adoc

This file was deleted.

4 changes: 2 additions & 2 deletions GOVERNANCE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ This repository adheres to hyperpolymath estate-wide policies:
* **License**: MPL-2.0 for code, CC-BY-SA-4.0 for prose (per standards/LICENCE-POLICY.adoc)
* **Code of Conduct**: Follows hyperpolymath CODE_OF_CONDUCT.md
* **Security**: Follows hyperpolymath SECURITY.md
* **Contributing**: Follows hyperpolymath CONTRIBUTING.adoc conventions
* **Contributing**: Follows hyperpolymath .github/CONTRIBUTING.md conventions

== Repository-Specific Conventions

Expand Down Expand Up @@ -148,7 +148,7 @@ Changes to this document require the same process as Significant Changes above.

* link:MAINTAINERS.adoc[Maintainers]
* link:CODE_OF_CONDUCT.md[Code of Conduct]
* link:CONTRIBUTING.adoc[Contributing Guide]
* link:.github/CONTRIBUTING.md[Contributing Guide]
* link:https://github.com/hyperpolymath/standards/blob/main/LICENCE-POLICY.adoc[Estate License Policy]
* link:https://github.com/hyperpolymath/standards[rhodium-standard-repositories (TPCF)]

Expand Down
2 changes: 1 addition & 1 deletion QUICKSTART-MAINTAINER.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Output: `{{BUILD_OUTPUT_PATH}}`

[source,bash]
----
guix build -f guix.scm
guix build -f build/guix.scm
----

=== Nix
Expand Down
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ SPDX-License-Identifier: MPL-2.0

== Contributing

See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc].
See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md].

== OPSM Link

Expand Down
67 changes: 0 additions & 67 deletions guix.scm

This file was deleted.

2 changes: 1 addition & 1 deletion tools/dispatcher/SECURITY.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ When using Reposystem, we recommend:
* https://github.com/hyperpolymath/reposystem/security/advisories[Security
Advisories]
* link:CHANGELOG.md[Changelog]
* link:CONTRIBUTING.adoc[Contributing Guidelines]
* link:../../.github/CONTRIBUTING.md[Contributing Guidelines]
* https://cve.mitre.org/[CVE Database]
* https://www.first.org/cvss/calculator/3.1[CVSS Calculator]

Expand Down
2 changes: 1 addition & 1 deletion tools/hud/.gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ rsr:compliance:
test -f LICENSE.txt && echo "✓ LICENSE.txt" && SCORE=$((SCORE+1)) || echo "✗ LICENSE.txt"
test -f SECURITY.md && echo "✓ SECURITY.md" && SCORE=$((SCORE+1)) || echo "✗ SECURITY.md"
test -f CODE_OF_CONDUCT.adoc && echo "✓ CODE_OF_CONDUCT.adoc" && SCORE=$((SCORE+1)) || echo "✗ CODE_OF_CONDUCT.adoc"
test -f CONTRIBUTING.adoc && echo "✓ CONTRIBUTING.adoc" && SCORE=$((SCORE+1)) || echo "✗ CONTRIBUTING.adoc"
test -f ../../.github/CONTRIBUTING.md && echo "✓ ../../.github/CONTRIBUTING.md" && SCORE=$((SCORE+1)) || echo "✗ ../../.github/CONTRIBUTING.md"
test -f GOVERNANCE.adoc && echo "✓ GOVERNANCE.adoc" && SCORE=$((SCORE+1)) || echo "✗ GOVERNANCE.adoc"
test -f flake.nix && echo "✓ flake.nix" && SCORE=$((SCORE+1)) || echo "✗ flake.nix"
test -f justfile && echo "✓ justfile" && SCORE=$((SCORE+1)) || echo "✗ justfile"
Expand Down
2 changes: 1 addition & 1 deletion tools/hud/Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ rsr-check:
@test -f LICENSE.txt && echo "✓ LICENSE.txt" || echo "✗ LICENSE.txt missing"
@test -f SECURITY.md && echo "✓ SECURITY.md" || echo "✗ SECURITY.md missing"
@test -f CODE_OF_CONDUCT.adoc && echo "✓ CODE_OF_CONDUCT.adoc" || echo "✗ CODE_OF_CONDUCT.adoc missing"
@test -f CONTRIBUTING.adoc && echo "✓ CONTRIBUTING.adoc" || echo "✗ CONTRIBUTING.adoc missing"
@test -f ../../.github/CONTRIBUTING.md && echo "✓ ../../.github/CONTRIBUTING.md" || echo "✗ ../../.github/CONTRIBUTING.md missing"
@test -f GOVERNANCE.adoc && echo "✓ GOVERNANCE.adoc" || echo "✗ GOVERNANCE.adoc missing"
@test -f flake.nix && echo "✓ flake.nix" || echo "✗ flake.nix missing"
@test -d .well-known && echo "✓ .well-known/" || echo "✗ .well-known/ missing"
Expand Down
2 changes: 1 addition & 1 deletion tools/hud/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,4 +225,4 @@ image::https://img.shields.io/badge/RSR-Gold-gold[RSR Gold]

== Contributing

See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines.
See link:../../.github/CONTRIBUTING.md[../../.github/CONTRIBUTING.md] for guidelines.
4 changes: 2 additions & 2 deletions tools/hud/guix.scm
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
;; SPDX-FileCopyrightText: 2025 hyperpolymath
;;
;; Guix package definition for git-hud
;; Build: guix build -f guix.scm
;; Shell: guix shell -D -f guix.scm
;; Build: guix build -f build/guix.scm
;; Shell: guix shell -D -f build/guix.scm

(use-modules (guix packages)
(guix gexp)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ defmodule Rhodibot.Checker do
check_any(path, ["README.adoc", "README.md"], "README"),
check_any(path, ["LICENSE.txt", "LICENSE", "LICENSE.md"], "LICENSE"),
check_any(path, ["CODE_OF_CONDUCT.adoc", "CODE_OF_CONDUCT.md"], "Code of Conduct"),
check_any(path, ["CONTRIBUTING.adoc", "CONTRIBUTING.md"], "Contributing guide")
check_any(path, ["../../../../../../../.github/CONTRIBUTING.md", "CONTRIBUTING.md"], "Contributing guide")
]
}
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ defmodule Rhodibot.Fixer do
"LICENSE.txt" => :license,
"SECURITY.md" => :security,
"CODE_OF_CONDUCT.adoc" => :code_of_conduct,
"CONTRIBUTING.adoc" => :contributing,
"../../../../../../../.github/CONTRIBUTING.md" => :contributing,
"GOVERNANCE.adoc" => :governance,
".github/FUNDING.yml" => :funding,
"flake.nix" => :flake,
Expand Down
2 changes: 1 addition & 1 deletion tools/hud/satellite-repos/rhodibot/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ rhodibot badge --format markdown
- [ ] `README.adoc` or `README.md`
- [ ] `LICENSE.txt`
- [ ] `CODE_OF_CONDUCT.adoc`
- [ ] `CONTRIBUTING.adoc`
- [ ] `../../../../.github/CONTRIBUTING.md`

=== 3. Security Architecture
- [ ] `SECURITY.md` - Vulnerability disclosure
Expand Down
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
Loading