Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (48 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 2.38 KB

🤝 Contributing to Havoc Hackathon

First off - thank you! 💜 Every contribution makes the arena better for everyone.

🎯 Ways to Contribute

💡 No Code Required!

You don't need to write code to help. Open an Issue for any of these:

  • 🐛 Report a bug - Did the hackathon break mid-run? Tell us!
  • 💡 Suggest a feature - New scoring criteria? Tournament modes? Let us know!
  • ✏️ Fix a typo - Spotted a mistake? We appreciate it!
  • 🎨 UX feedback - Was the ceremony dramatic enough? 🏟️

🧑‍💻 Code Contributions

  1. Fork this repo
  2. Create a branch: git checkout -b my-improvement
  3. Make your changes - see the development guide below
  4. Test your changes - see TESTING.md
  5. Open a PR - fill out the template and describe what you changed

🛠️ Development Setup

Prerequisites

Local Testing

  1. Clone the repo:

    git clone https://github.com/DUBSOpenHub/havoc-hackathon.git
cd havoc-hackathon

  2. Register the skill locally in a Copilot CLI session:

    /skills add ./

  3. Test a hackathon run:

    run hackathon  -  write a fizzbuzz function

  4. Verify your changes against the TESTING.md playbooks.

📝 What Makes a Good Contribution

  • 🎭 Keep the MC energy - this is a hackathon, not a board meeting!
  • ⚖️ Fair play - judging logic must stay unbiased
  • 🔒 Sealed judging - never leak model identity to judges
  • 📋 Evidence-based - scoring must cite evidence
  • 🧪 Test your changes - run through the conversation flow
  • 🔄 Keep SKILL.md in sync - the skill file exists in two locations (skills/havoc-hackathon/SKILL.md and .github/skills/havoc-hackathon/SKILL.md). If you edit one, copy the changes to the other so they stay identical.

📋 Pull Request Guidelines

  • Keep PRs focused - one improvement per PR
  • Update CHANGELOG.md with your change
  • Follow existing file naming conventions
  • If changing scoring logic, explain the rationale

🐙 Code of Conduct

Please read our Code of Conduct. We're building an inclusive community! 💜