🍂Hacktoberfest
Welcome to Hacktoberfest, a month-long celebration of open source contributions! At AppFlowy, we're excited to be part of this global event, and we invite you to join us in making a positive impact on our project.
What is Hacktoberfest?
Hacktoberfest is an annual event that encourages individuals to dive into the world of open source software development. It's an excellent opportunity for developers, both beginners and veterans, to contribute to meaningful projects, improve their skills, and connect with the open source community.
Here's how it works:
Duration: Hacktoberfest runs throughout the month of October.
Goal: Participants are encouraged to make at least four pull requests (PRs) to open source repositories on platforms like GitHub.
Rewards: Complete the challenge, and you'll receive a limited-edition Hacktoberfest T-shirt (provided you meet the participation criteria).
Getting Started with AppFlowy for Hacktoberfest
AppFlowy is excited to be part of Hacktoberfest, and we welcome your contributions to our open source project! Here's how you can get started:
Step 1: Set Up Your Development Environment
GitHub Account: If you don't have one already, create a GitHub account – it's free!
Git: Install Git on your computer if you haven't already. Git is a version control system that you'll use to manage your contributions.
Fork AppFlowy: Visit the AppFlowy GitHub repository and click the "Fork" button in the top-right corner. This creates a copy of our repository under your GitHub account.
Step 2: Explore the AppFlowy Project
Take some time to familiarize yourself with the AppFlowy project. Here are a few ways to get started:
Read the Software Contribution Guidelines: Check out our guidelines for software contributions, and familiarise yourself with our conventions.
Run the Project: A good starting point is getting the project to build and run.
Issues: Browse our GitHub issues to find tasks that interest you. We label beginner-friendly issues as "Hacktoberfest" to help you get started.
Step 3: Make Your Contribution
Once you've identified an issue you'd like to work on:
Claim the Issue: Comment on the issue to express your interest in working on it. This helps us avoid duplicate efforts, and a team member will assign you the issue as soon as possible.
Fork and Clone: If you have not already, click the "Fork" button on the repository to create a copy of the repository under your account. Then, clone your forked repository to your local machine using Git.
Create a Branch: Create a new branch for your work, keeping your main branch clean.
Code and Test: Make your code changes, and test them thoroughly.
Commit and Push: Commit your changes to your branch, and push them to your forked repository on GitHub.
Open a Pull Request: On GitHub, open a pull request from your branch to the original AppFlowy repository. Reference the issue you're addressing in your PR.
Collaborate: Engage in discussion with our maintainers and other contributors to refine your PR and address any feedback.
Join Us in Making a Difference
Hacktoberfest is not just about coding; it's also about learning, collaborating, and giving back to the open source community. We look forward to your contributions and hope you find your experience with AppFlowy and Hacktoberfest rewarding.
If you have questions, need guidance, or want to chat with fellow contributors, check out the Get in contact page . Let's make Hacktoberfest 20XX a memorable one together!
Happy hacking!
Last updated