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
124 changes: 112 additions & 12 deletions scaffoldia/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,120 @@
// SPDX-License-Identifier: PMPL-1.0-or-later
= Contributing Guide
= Clone the repository
git clone https://github.com/hyperpolymath/scaffoldia.git
cd scaffoldia

== Getting Started
= Using Nix (recommended for reproducibility)
nix develop

1. Fork the repository
2. Create a feature branch from `main`
3. Sign off commits (`git commit -s`)
4. Submit a pull request
= Or using toolbox/distrobox
toolbox create scaffoldia-dev
toolbox enter scaffoldia-dev
= Install dependencies manually

== Commit Guidelines
= Verify setup
just check # or: cargo check / mix compile / etc.
just test # Run test suite
[listing]
----

* Conventional commits: `type(scope): description`
* Sign all commits (DCO required)
* Atomic, focused commits
### Repository Structure
----
scaffoldia/
├── 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)
[listing]
----

== License
---

Contributions licensed under project license.
## 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/scaffoldia/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/scaffoldia/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/scaffoldia/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/scaffoldia/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)
[listing]
----

### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):
----
<type>(<scope>): <description>

[optional body]

[optional footer]
124 changes: 112 additions & 12 deletions tools/dispatcher/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,120 @@
// SPDX-License-Identifier: PMPL-1.0-or-later
= Contributing Guide
= Clone the repository
git clone https://github.com/hyperpolymath/reposystem.git
cd reposystem

== Getting Started
= Using Nix (recommended for reproducibility)
nix develop

1. Fork the repository
2. Create a feature branch from `main`
3. Sign off commits (`git commit -s`)
4. Submit a pull request
= Or using toolbox/distrobox
toolbox create reposystem-dev
toolbox enter reposystem-dev
= Install dependencies manually

== Commit Guidelines
= Verify setup
just check # or: cargo check / mix compile / etc.
just test # Run test suite
[listing]
----

* Conventional commits: `type(scope): description`
* Sign all commits (DCO required)
* Atomic, focused commits
### 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)
[listing]
----

== License
---

Contributions licensed under project license.
## 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)
[listing]
----

### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):
----
<type>(<scope>): <description>

[optional body]

[optional footer]
124 changes: 112 additions & 12 deletions tools/reunify/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,120 @@
// SPDX-License-Identifier: PMPL-1.0-or-later
= Contributing Guide
= Clone the repository
git clone https://github.com/hyperpolymath/git-reunify.git
cd git-reunify

== Getting Started
= Using Nix (recommended for reproducibility)
nix develop

1. Fork the repository
2. Create a feature branch from `main`
3. Sign off commits (`git commit -s`)
4. Submit a pull request
= Or using toolbox/distrobox
toolbox create git-reunify-dev
toolbox enter git-reunify-dev
= Install dependencies manually

== Commit Guidelines
= Verify setup
just check # or: cargo check / mix compile / etc.
just test # Run test suite
[listing]
----

* Conventional commits: `type(scope): description`
* Sign all commits (DCO required)
* Atomic, focused commits
### Repository Structure
----
git-reunify/
├── 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)
[listing]
----

== License
---

Contributions licensed under project license.
## 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/git-reunify/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/git-reunify/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/git-reunify/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/git-reunify/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)
[listing]
----

### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):
----
<type>(<scope>): <description>

[optional body]

[optional footer]
Loading
Loading