README / .github /copilot-instructions.md
John Bowyer
chore: Add LICENSE file and update README with licensing information
a456339

GitHub Copilot Instructions

Commit Message Standards

ALWAYS use Conventional Commits format for all commit messages:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Commit Types

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that don't affect code meaning (whitespace, formatting)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Performance improvements
  • test: Adding or correcting tests
  • chore: Changes to build process or auxiliary tools
  • ci: Changes to CI configuration files and scripts

Examples

feat(readme): add Apache 2.0 license information
fix(docker): correct build output directory path
docs(license): update copyright year to 2026
chore(deps): update npm dependencies

Project Context

This is the CommunityOne HuggingFace Space repository - an organization card/landing page.

  • Platform: HuggingFace Spaces
  • SDK: Docker
  • Tech Stack: TypeScript, Vite, Tailwind CSS
  • License: Apache 2.0
  • Deployment: Automatic on push to main branch

Code Style

  • Use TypeScript for all source files
  • Follow Tailwind CSS conventions for styling
  • Keep README.md concise and focused on project overview
  • Maintain HuggingFace frontmatter in README.md

Deployment Notes

  • Changes auto-deploy to HuggingFace when pushed
  • Test Docker builds locally before pushing
  • Ensure Dockerfile is optimized for HuggingFace Spaces environment