Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.09 KB

File metadata and controls

40 lines (28 loc) · 1.09 KB

Contributing

Thanks for improving hackathon.md.

This repo should stay small, practical, and easy to inspect. The goal is a useful playbook, not a giant framework.

Good Contributions

  • clearer wording
  • better checklists
  • safer privacy/security guidance
  • examples that help agents choose a smaller, better demo
  • compatibility notes for different coding agents
  • fixes for install instructions

Out Of Scope

  • platform-specific marketing copy
  • large generated documents
  • hidden prompt-injection tricks
  • unverifiable claims about hackathon rules
  • scripts that require secrets or external accounts

Pull Request Checklist

  • Keep changes focused.
  • Do not include secrets, tokens, personal data, screenshots with private information, or real hackathon submissions.
  • Keep examples generic.
  • If you add a rule that depends on a platform or event, link to an official source.
  • Check Markdown formatting before opening the PR.

Local Review

Before opening a PR:

git diff --check
grep -RInE 'api[_-]?key|secret|token|password|BEGIN (RSA|OPENSSH|PRIVATE)' . --exclude-dir=.git || true