Skip to content

CONTRIBUTING.adoc

Latest commit

 

History

History
52 lines (38 loc) · 1.63 KB

CONTRIBUTING.adoc

File metadata and controls

52 lines (38 loc) · 1.63 KB
Raw

Contributing to dictask

This document explains how to contribute to dictask. 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:

  • Rust code: Improving ingest, transcription, store, or review components.

  • Haskell parser: Enhancing NLP task extraction patterns.

  • Idris2 proofs: Strengthening formal verification of task schema.

  • Documentation: Improving AsciiDoc manuals or AI manifests.

  • Testing: Adding property-based tests or integration tests.

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 tools (Rust, Haskell/GHC, Idris2, Zig).

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

Language Policy

Allowed Use Case

Rust

Ingest, transcription, store, review, CLI

Haskell

NLP parsing (megaparsec)

Idris2

ABI definitions, formal proofs

Zig

FFI bridge

Bash

Scripts, automation

Not allowed: Python, TypeScript, Node.js, Go, Java.

Contribution Policies

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

Code of Conduct

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