Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (22 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.28 KB

Contributing to BrainAV Profile & Website

Thank you for your interest in contributing to the BrainAV organization hub!

👋 Scope

This repository (.github) hosts the Organization Profile and the BrainAV.ca landing page.

Note: If you are looking to contribute to the AI tools (Python/OSC), please refer to the specific product repositories linked in the README.

🛠️ Tech Stack (This Repo)

  • Frontend: Vanilla JavaScript, HTML5, CSS3 (Variables).
  • Documentation: Markdown.

🚀 Getting Started

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/BrainAV/.github.git
  3. Create a branch: git checkout -b feature/amazing-feature

📝 Workflow

  1. Check the Roadmap: Ensure your contribution aligns with roadmap.md.
  2. Follow Standards:
    • Code: See .gemini/AI_DEV_GUIDE.md.
    • Design: See DESIGN_GUIDE.md.
  3. Commit Messages: Use clear, descriptive messages (e.g., feat: update landing page hero or docs: refine readme).
  4. Update Changelog: Add a line to the [Unreleased] section of CHANGELOG.md for any notable change.

🧪 Testing

  • Frontend: Verify responsiveness and accessibility across devices.
  • Links: Ensure all links to external product repositories are valid.