# Contributing to Awesome Generative UI

Thank you for your interest in contributing! This document provides guidelines for contributions.

## Adding a New Resource

### What We're Looking For

1. **Directly Related to Generative UI** — The resource should be specifically about AI-generated user interfaces, not just general AI or general UI development.

2. **Quality Threshold**
   - Tools/Frameworks: Should be functional, documented, and either actively maintained or historically significant
   - Research: Should be from reputable sources (academic, major tech companies, well-known practitioners)
   - Articles: Should provide substantial insight, not just surface-level overviews

3. **Accessible** — Must be publicly accessible (open source, published paper, public blog post)

### What We're NOT Looking For

- General AI/LLM resources without specific UI generation focus
- Paywalled content without free alternatives
- Self-promotional content without substantial value
- Vaporware or pre-announcement products
- Duplicates of existing entries

## How to Contribute

### Quick Additions

For simple additions, open an issue with:
- Resource name and URL
- Brief description (1-2 sentences)
- Which section it belongs in

### Pull Requests

1. Fork the repository
2. Create a new branch: `git checkout -b add-resource-name`
3. Make your changes
4. Submit a PR with:
   - What you're adding
   - Why it belongs here
   - Any relevant context

### Format Guidelines

```markdown
- [Resource Name](https://url.com/) - Organization/Author. Brief description of what it does and why it's notable.
```

- Use a plain hyphen surrounded by spaces (` - `) as the separator between the link and description. This is required by `awesome-lint` (which runs in CI); em-dashes or bold link text will fail the check.
- Include organization/author when relevant.
- Keep descriptions concise (under 30 words).
- Match the style of existing entries in the same section.

## Section Guidelines

### Research
- Academic papers should include arxiv or publication link
- Include year of publication
- Note significance (foundational, benchmark, etc.)

### Specifications & Protocols
- Must be documented specification, not just implementation
- Note if it's open vs proprietary

### Frameworks & SDKs
- Must have documentation
- Note maturity level (production-ready, emerging, experimental)

### Platforms & Tools
- Must be accessible (free tier or open source)
- Note primary use case

### Component Libraries
- Focus on libraries commonly used in generative UI contexts
- Note framework (React, Vue, etc.)

## Updating Existing Entries

- Fix broken links
- Update descriptions for accuracy
- Add new features or status changes
- Correct categorization

## Questions?

Open an issue with the "question" label.