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
71 changes: 71 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing

Thank you for your interest in contributing! We follow a “Dual-Track”
architecture where human-readable documentation lives in the root and
machine-readable policies live in `.machine_readable/`.

## How to Contribute

We welcome contributions in many forms:

- **Code:** Improving the core stack or extensions

- **Documentation:** Enhancing docs or AI manifests

- **Testing:** Adding property-based tests or formal proofs

- **Bug reports:** Filing clear, reproducible issues

## Getting Started

1. **Read the AI Manifest:** Start with `0-AI-MANIFEST.a2ml` (if
present) to understand the repository structure.

2. **Environment:** Use `nix` `develop` or `direnv` `allow` to set up
your tools.

3. **Task Runner:** Use `just` to see available commands (`just`
`--list`).

## Development Workflow

### Branch Naming

docs/short-description # Documentation
test/what-added # Test additions
feat/short-description # New features
fix/issue-number-description # Bug fixes
refactor/what-changed # Code improvements
security/what-fixed # Security fixes

### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: `feat`, `fix`, `docs`, `test`, `refactor`, `ci`, `chore`,
`security`

## Reporting Bugs

Before reporting: 1. Search existing issues 2. Check if it’s already
fixed in `main`

When reporting, include: - Clear, descriptive title - Environment
details (OS, versions, toolchain) - Steps to reproduce - Expected vs
actual behaviour

## Code of Conduct

All contributors are expected to adhere to our [Code of
Conduct](CODE_OF_CONDUCT.md).

## License

By contributing, you agree that your contributions will be licensed
under the same license as the project (see LICENSE).
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 @@ -34,7 +34,7 @@ jobs:
fi
- 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 @@ -75,7 +75,7 @@ jobs:
fi
- 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
71 changes: 0 additions & 71 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
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.

2 changes: 1 addition & 1 deletion tests/validate-documentation.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ done

# Test 4: Required documentation files
echo "✓ Checking required documentation files..."
REQUIRED_DOCS=("README.adoc" "CHANGELOG.adoc" "ROADMAP.adoc" "CONTRIBUTING.adoc"
REQUIRED_DOCS=("README.adoc" "CHANGELOG.adoc" "ROADMAP.adoc" "../.github/CONTRIBUTING.md"
"CODE_OF_CONDUCT.md" "SECURITY.md" "LICENSE")
for doc in "${REQUIRED_DOCS[@]}"; do
if [ ! -f "$doc" ]; then
Expand Down
Loading