⭐ Thank you for your interest in contributing!
Here’s how you can participate during Hacktoberfest:
-
Pick an Issue: Choose GitHub Issues tagged
hacktoberfestfrom our issues list and ask to be assigned. -
Fork and Clone: Fork and clone the CopilotKit repository to your local machine.
-
Create a Branch: Create a branch for your changes.
-
Develop: Work on your assigned issue. Be sure to sync your branch with the main branch frequently to ensure compatibility.
-
Copy the Template: Navigate to the TEMPLATE.md file in the repository. Copy its content as the baseline for your submission.
-
Add Your Info: Fill out the template with details about your project:
- Project Title:
- Description: Purpose and value of your demo.
- Technologies Being Used: List technologies and frameworks used.
- App Link: If live, include the link.
- Screenshot: Attach a screenshot of your demo.
- Detailed Description: Explain functionality and features.
- Who Are You?: Introduce yourself and your motivation.
- Additional Resources/Info: Link to any extra resources or information.
-
Create a Demo's File: Save the pre-filled template as a Markdown file (.md) in the
demosfolder. Name the file after your project, in lowercase.
- Pull Request: Submit a pull request (PR) with your project file in the
demosdirectory. Ensure your PR description links to the issue you addressed. - Code Review: Wait for feedback from the project maintainers and make any required revisions.
- Merge: After approval, your changes will be merged with the
hacktoberfest-acceptedlabel to ensure you will receive credit from the official Hacktoberfest organization.
- Questions: Use our Discord support channel for any questions you have.
- Resources: Visit CopilotKit documentation for more helpful documentatation info.
⭐ Happy coding and we look forward to your contributions!