Skip to content

CONTRIBUTING.adoc

Latest commit

 

History

History
73 lines (49 loc) · 2.06 KB

CONTRIBUTING.adoc

File metadata and controls

73 lines (49 loc) · 2.06 KB
Raw

Contributing to AcceleratorGate.jl

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.

  • 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

<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 is 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 ethical standards. See CODE_OF_CONDUCT for details.

License

By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE).