Skip to content

CONTRIBUTING.adoc

Latest commit

 

History

History
26 lines (17 loc) · 1.14 KB

CONTRIBUTING.adoc

File metadata and controls

26 lines (17 loc) · 1.14 KB

Contributing to {project-name}

This document explains how to contribute to the project. We follow a "Dual-Track" architecture where human-readable documentation lives in the root and machine-readable policies live in .machine_readable/.

Table of Contents

How to Contribute

We welcome contributions in many forms: * Code: Improving the core verified stack or extensions. * Documentation: Enhancing AsciiDoc manuals or AI manifests. * Testing: Adding property-based tests or formal proofs.

Getting Started

  1. Read the AI Manifest: Start with 0-AI-MANIFEST.a2ml to understand the repository structure.

  2. Environment: Use nix develop or direnv allow to set up your tools (Idris2, Zig, Rust).

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

Contribution Policies

For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at CONTRIBUTING.adoc.

Code of Conduct

All contributors are expected to adhere to our ethical standards. See CODE_OF_CONDUCT.adoc for details.