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
88 changes: 88 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
# Getting started
```bash
git clone https://github.com/hyperpolymath/kaldor-iiot.git
cd kaldor-iiot

# Using mise (recommended: provision the pinned toolchain)
mise install

# Task runner (see Justfile)
just --list # available tasks
just check # verify setup / static checks
just test # run the test suite
```

---

## 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](../docs/status/ROADMAP.adoc) 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/kaldor-iiot/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/kaldor-iiot/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/kaldor-iiot/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/kaldor-iiot/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/):
```
<type>(<scope>): <description>

[optional body]

[optional footer]
```
1 change: 1 addition & 0 deletions .machine_readable/root-allow.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
CLAUDE.md
build/ # build orchestration: guix.scm relocated here (canon 1.2.1 guix-primary template_ref = "build/")
3 changes: 0 additions & 3 deletions CONTRIBUTING.adoc

This file was deleted.

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

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

=== Nix
Expand Down
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ deno run scripts/governance/vote.ts \
|Community standards + TPCF
|✅ Complete

|link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]
|link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md]
|Contribution guide with TPCF perimeters
|⚠️ In Progress

Expand Down Expand Up @@ -187,7 +187,7 @@ Kaldor-IIoT/
├── LICENSE.txt # Palimpsest v0.8
├── SECURITY.md # Security policy
├── CODE_OF_CONDUCT.md # Community standards
├── CONTRIBUTING.adoc # Contribution guide
├── .github/CONTRIBUTING.md # Contribution guide
├── GOVERNANCE.adoc # Governance model
└── MAINTAINERS.md # TPCF perimeter assignments
----
Expand Down Expand Up @@ -240,7 +240,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0

== Contributing

We welcome contributions from all 3 TPCF perimeters! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for:
We welcome contributions from all 3 TPCF perimeters! See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md] for:

* Perimeter 1 (Core): Consensus voting for critical changes
* Perimeter 2 (Expert): 2-approval model for features
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
28 changes: 0 additions & 28 deletions guix.scm

This file was deleted.

Loading