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

# Using Nix (recommended for reproducibility)

nix develop

# Or using toolbox/distrobox

toolbox create sanctify-php-dev toolbox enter sanctify-php-dev \#
Install dependencies manually

# Verify setup

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


### Repository Structure

sanctify-php/ ├── 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/sanctify-php/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/sanctify-php/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/sanctify-php/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/sanctify-php/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\]
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions .github/workflows/dogfood-gate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:

- name: Validate A2ML manifests
if: steps.detect.outputs.count > 0
run: bash .githooks/validate-a2ml.sh
run: bash .github/hooks/validate-a2ml.sh
- name: Write summary
run: |
A2ML_COUNT="${{ steps.detect.outputs.count }}"
Expand Down Expand Up @@ -83,7 +83,7 @@ jobs:

- name: Validate K9 contracts
if: steps.detect.outputs.k9_count > 0
run: bash .githooks/validate-k9.sh
run: bash .github/hooks/validate-k9.sh
- name: Write summary
run: |
K9_COUNT="${{ steps.detect.outputs.k9_count }}"
Expand Down
109 changes: 0 additions & 109 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 @@ -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 QUICKSTART.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ sudo apt-get install libgmp-dev libffi-dev zlib1g-dev
* Read the full documentation: link:docs/USER-GUIDE.adoc[User Guide]
* Explore advanced features: link:docs/ADVANCED.adoc[Advanced Usage]
* Learn about WordPress integration: link:docs/WORDPRESS.adoc[WordPress Guide]
* Contribute to development: link:CONTRIBUTING.adoc[Contributing Guide]
* Contribute to development: link:.github/CONTRIBUTING.md[Contributing Guide]
* Report issues: https://github.com/hyperpolymath/sanctify-php/issues

== Support
Expand Down
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ cabal install
nix build

# Using Guix
guix build -f guix.scm
guix build -f build/guix.scm
----

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