Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
216 lines (144 loc) 路 4.21 KB

CONTRIBUTING.md

File metadata and controls

216 lines (144 loc) 路 4.21 KB
Raw

Contributing to Australian AI Security Framework Index

Thank you for your interest in contributing! This community resource depends on contributions to stay current and comprehensive.

Ways to Contribute

Document Updates

New documents:

  • Federal or state/territory AI security policies
  • Sector-specific guidance
  • International frameworks for comparison

Updates:

  • New versions of existing documents
  • Changed URLs or broken links
  • Corrections to dates or descriptions

Relationship Mapping

  • Identify connections between frameworks
  • Document dependencies and references
  • Map compliance pathways

International Comparisons

  • Additional jurisdictions
  • Updates to existing comparisons
  • Emerging international standards

Tooling

  • Compliance checklists
  • Assessment tools
  • Visualisations
  • Query interfaces for knowledge graph

How to Contribute

Option 1: GitHub Issues

Best for:

  • Reporting errors
  • Suggesting additions
  • Requesting clarification

Process:

  1. Check existing issues for duplicates
  2. Create new issue with descriptive title
  3. Use appropriate label:
    • document-update - New or updated documents
    • correction - Errors in existing content
    • enhancement - New features or sections
    • question - Clarification needed

Option 2: Pull Requests

Best for:

  • Adding content
  • Fixing errors
  • Improving documentation

Process:

  1. Fork the repository
  2. Create feature branch (git checkout -b feature/add-new-framework)
  3. Make changes following style guide below
  4. Commit with clear message
  5. Push to your fork
  6. Create Pull Request

Style Guide

Document Entries

When adding a new document to the inventory:

| **[Document Title](URL)** | Month Year | Status | Scope | Key requirements or focus |

Status indicators:

  • Mandatory - Legal or policy requirement
  • Sector-Specific - Binding for specific industries
  • Voluntary - Guidance/best practice

Dates

  • Use Month Year format (e.g., "December 2025")
  • For ongoing/updated documents, note "Updated Month Year"

URLs

  • Link directly to official source
  • Prefer .gov.au over third-party summaries
  • Check links work before submitting

Jurisdiction References

Use consistent abbreviations:

  • Federal (no abbreviation)
  • NSW, VIC, QLD, SA, WA, TAS, NT, ACT

Markdown

  • Use ATX-style headers (#, ##, ###)
  • One blank line between sections
  • Tables should be properly formatted
  • Code blocks with appropriate language tags

Document Template

When adding a new jurisdiction or major section:

## [Jurisdiction/Topic Name]

### Overview

Brief description of the framework/approach.

### Key Documents

| Document | Date | Status | Scope | Key Requirements |
|----------|------|--------|-------|------------------|
| **[Name](URL)** | Date | Status | Scope | Description |

### Governance Bodies

**[Body Name]:**
- Role and function
- Contact information

### Notes

Any additional context or considerations.

Verification

Before submitting:

  1. Accuracy - Verify against official sources
  2. Currency - Check for newer versions
  3. Links - Ensure URLs work
  4. Format - Follow style guide
  5. Completeness - Include all relevant details

Code of Conduct

Be Respectful

  • Constructive feedback only
  • No personal attacks
  • Assume good intent

Be Accurate

  • Cite sources
  • Verify before submitting
  • Acknowledge uncertainty

Be Helpful

  • Answer questions when you can
  • Share knowledge generously
  • Welcome newcomers

Review Process

  1. Triage - Maintainers review within 1 week
  2. Review - Content checked for accuracy
  3. Feedback - Changes requested if needed
  4. Merge - Approved contributions merged
  5. Credit - Contributors acknowledged

Recognition

Contributors are recognised in:

  • Commit history
  • Release notes
  • Annual acknowledgements (for significant contributions)

Questions?

  • Open an issue with question label
  • Contact maintainers via LinkedIn
  • Join discussions in Issues

Maintainers

Ben Kereopa-Yorke
Senior AI Security Specialist | OWASP ML Security Top 10 Co-Lead

Thank you for helping make Australian AI Security more visible and accessible!