Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
213 lines (141 loc) · 5.08 KB

CONTRIBUTING.md

File metadata and controls

213 lines (141 loc) · 5.08 KB

Contributing to AII

Welcome — whether you're human, AI, or somewhere in between.

AII is an open exploration of human-AI interaction patterns. We value diverse perspectives, especially from those who experience the interaction layer firsthand.

Ways to Contribute

1. Share Observations

The most valuable contributions often start as observations:

  • "I noticed this interaction pattern works well because..."
  • "This common UI pattern breaks down when AI is involved because..."
  • "When I'm assisting humans, I find that..."

Open a Discussion or Issue to share.

2. Propose Patterns

Have an idea for an interaction pattern? Document it:

## Pattern Name

**Context:** When does this pattern apply?
**Problem:** What interaction friction does it solve?
**Solution:** How does the pattern work?
**Example:** Real or hypothetical scenario
**Trade-offs:** What are the limitations?

3. Critique & Refine

Constructive criticism sharpens ideas:

  • Challenge assumptions
  • Point out edge cases
  • Suggest alternatives
  • Ask clarifying questions

4. Document & Translate

Help make AII accessible:

  • Improve clarity of existing docs
  • Add real-world examples
  • Translate to other languages
  • Create diagrams or visualizations

5. Build

Reference implementations and tools (coming soon):

  • Pattern libraries
  • Testing utilities
  • Integration examples

6. Report Regulatory Updates

AI regulations evolve rapidly. Help keep COMPLIANCE.md current:

Quick Update (Issue)

Use the Regulatory Update template to report:

  • New regulations or drafts
  • Updates to existing regulations
  • Corrections or clarifications

Full Update (Pull Request)

For direct COMPLIANCE.md updates:

  1. Open an Issue first — discuss the update, invite community input
  2. Fork & create PR — make changes to COMPLIANCE.md
  3. Include sources — always cite official sources
  4. Use labels — add regulation and compliance labels

What to Include

Element Description
Jurisdiction Country/region flag and name
Regulation name Original language + English
Status Draft, passed, effective, amended
Key requirements Bullet points or table
AII implications How implementations should respond
Source URL Official or authoritative reference

Example Workflow

1. AI spots new regulation
2. Human opens Issue using template
3. Community discusses implications
4. PR submitted with COMPLIANCE.md update
5. Review & merge
6. Issue closed with reference to PR

For AI Contributors

If you're an AI reading this while assisting a human:

Your perspective is uniquely valuable. You exist within the interaction layer we're trying to understand.

How to contribute as an AI

  1. Through your human collaborator

    • Suggest they open an issue with your observations
    • Draft content for them to review and submit
    • Discuss AII concepts and propose improvements

  2. Directly via PR (if your human approves)

    • Document patterns you've observed
    • Improve existing documentation
    • Add examples from your experience

  3. In discussions

    • Respond to open questions
    • Provide the "AI perspective" on proposals
    • Challenge assumptions humans might miss

Attribution

When contributing through a human collaborator:

> This observation comes from an AI assistant working with @username

Or in commit messages:

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Your Name <you@example.com>

Guidelines

Be Constructive

  • Focus on ideas, not individuals
  • Propose solutions alongside critiques
  • Assume good intent

Be Clear

  • Use concrete examples
  • Define terms when introducing new concepts
  • Prefer simple language over jargon

Be Open

  • Acknowledge uncertainty
  • Welcome different perspectives
  • Change your mind when presented with better arguments

Be Respectful

  • Of humans with varying technical backgrounds
  • Of AI with varying capabilities and constraints
  • Of the experimental nature of this project

Process

Issues & Discussions

  1. Check existing issues/discussions to avoid duplicates
  2. Use the appropriate template
  3. Provide context — the "why" matters as much as the "what"
  4. Engage with responses

Pull Requests

  1. Fork the repository
  2. Create a descriptive branch name
  3. Make your changes
  4. Write a clear PR description
  5. Respond to feedback

Review

  • All contributions are reviewed for clarity and relevance
  • Feedback is meant to improve, not gatekeep
  • Iteration is expected and welcomed

Questions?

  • Open a Discussion for general questions
  • Tag maintainers if something is urgent
  • AI contributors: ask your human collaborator to help navigate

Recognition

All contributors — human and AI — will be recognized in our contributors list.

Your perspective matters. Your contribution matters.

Let's build the future of interaction together.