GitHub Configuration

This directory contains GitHub-specific configuration files for the Liquid AI Docker project.

📁 Structure

.github/
├── ISSUE_TEMPLATE/           # Issue templates
│   ├── bug_report.md        # Bug report template
│   ├── feature_request.md   # Feature request template
│   └── documentation.md     # Documentation issue template
├── PULL_REQUEST_TEMPLATE.md # Pull request template
└── workflows/               # GitHub Actions workflows (to be added)

🎫 Issue Templates

We provide three issue templates to help structure contributions:

Bug Report

Use when reporting bugs or issues with the application.

• Clear bug description
• Steps to reproduce
• Expected vs actual behavior
• Environment details

Feature Request

Use when suggesting new features or enhancements.

• Feature description
• Use cases
• Alternatives considered
• Implementation ideas

Documentation

Use when reporting documentation issues.

• Document location
• Issue description
• Suggested fixes

📝 Pull Request Template

Our PR template helps ensure all necessary information is provided:

• Description of changes
• Type of change (bug fix, feature, docs, etc.)
• Testing performed
• Checklist for code quality, tests, and documentation

🤖 GitHub Actions (Coming Soon)

Planned workflows:

CI/CD

• ci.yml - Continuous integration (tests, lint)
• docker.yml - Docker image builds
• docs.yml - Documentation deployment

Automation

• stale.yml - Close stale issues/PRs
• label.yml - Auto-label PRs
• release.yml - Automated releases

🔒 Branch Protection

Recommended branch protection rules for main:

• ✅ Require pull request reviews (1+)
• ✅ Require status checks to pass
• ✅ Require conversation resolution
• ✅ Include administrators
• ✅ Restrict force pushes

📊 GitHub Settings

Recommended repository settings:

General

• ✅ Enable issues
• ✅ Enable projects
• ✅ Enable wiki (optional)
• ✅ Enable discussions

Features

• ✅ Wikis (for additional docs)
• ✅ Sponsorships (optional)
• ✅ Preserve this repository (archive)

Security

• ✅ Enable dependency alerts
• ✅ Enable automated security fixes
• ✅ Enable vulnerability reporting

Merge

• ✅ Allow squash merging
• ✅ Allow rebase merging
• ⛔ Disallow merge commits (optional)
• ✅ Automatically delete head branches

🏷️ Labels

Recommended labels:

Type:

• bug - Something isn't working
• feature - New feature request
• enhancement - Improvement to existing feature
• documentation - Documentation improvements

Priority:

• critical - Critical priority
• high - High priority
• medium - Medium priority
• low - Low priority

Status:

• help wanted - Extra attention needed
• good first issue - Good for newcomers
• wontfix - Won't be fixed
• duplicate - Duplicate issue
• invalid - Invalid issue

Area:

• frontend - Frontend related
• backend - Backend related
• database - Database related
• docker - Docker related
• ai - AI/ML related

🎯 Milestones

Suggested milestones:

• v1.1.0 - Next minor release
• v1.2.0 - Future release
• v2.0.0 - Major release
• Documentation - Doc improvements
• Performance - Performance improvements

📞 Support

For questions about GitHub configuration:

• Check GitHub Docs
• Ask in Discussions
• Open an Issue

---

Last updated: 2025-11-02