Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.96 KB
Raw

Contributing to CopilotKit Hacktoberfest

⭐ Thank you for your interest in contributing!
Follow these steps to get started and submit your Hacktoberfest project.

How to Contribute

  1. Pick an Issue: Browse GitHub Issues tagged hacktoberfest and ask to be assigned. Multiple contributors can join the same issue.
  2. Set Up Your Environment: Install CopilotKit packages locally and make sure you can run your project.
  3. Develop Your Project: Build your demo or complete your assigned issue.

Preparing Your Demo Submission

  1. Use the Template: Open TEMPLATE.md and copy its contents.
  2. Fill in Details: Update the template with:
    • Project Title
    • Description (purpose and value of your demo)
    • Technologies Used
    • App Link (if deployed)
    • Screenshot
    • Detailed Description (features and functionality)
    • About You (short intro + motivation)
    • Additional Resources (optional)
  3. Save Your File: Add your completed template as a new .md file in the demos_2025 folder. Name the file after your project in lowercase (e.g., my-demo.md).

Submitting Your Contribution

  1. Open a Pull Request: Submit a PR that includes your demo file in the demos_2025 folder. In the PR description, link the issue you worked on.
  2. Review Process: Maintainers will review your PR and provide feedback if changes are needed.
  3. Merge & Credit: Once approved, your PR will be merged and tagged with hacktoberfest-accepted so you receive official Hacktoberfest credit.

Need Help?

⭐ Happy coding — we can’t wait to see your demos!