DEV Community

Cover image for Hacktoberfest 2023 for Maintainers
Brian Bethencourt for The DEV Team

Posted on • Edited on

Hacktoberfest 2023 for Maintainers

If you're planning to maintain a project during Hacktoberfest this year…

Dwight from The Office US saying "Thank You"

Your dedication and hard work won't go unnoticed. It's time to set aside any impostor syndrome feelings because you're about to make a significant impact this coming month.


Preparing your Repo 🛠

We want you to get the most out of Hacktoberfest, and a good part of that is going to be based on how you set up your repository to take on these new contributors. If at any time you have questions or concerns during the event, you can check out this page: https://hacktoberfest.com/participation/#maintainers

First, you'll need to opt-in to Hacktoberfest. If you don't take on these basic steps, contributors won't know if your repo is Hacktoberfest-eligible.

Here's what you have to do:

  1. Add the “hacktoberfest” topic to your repository to opt-in to Hacktoberfest and indicate you’re looking for contributions.
  2. Apply the “hacktoberfest” label to issues you want contributors to help with in your GitHub or GitLab project.
  3. Add a CONTRIBUTING.md file with contribution guidelines to your repository. Include details like how to fork the repository, make changes, and submit pull requests.
  4. Adopt a code of conduct to create a greater sense of inclusion and community for contributors. It sets the tone for respectful and inclusive collaboration.

That's all you need to get started!

During the month of October, you will want to be ready to review pull/merge requests that are submitted from Hacktoberfest contributors. Any that are valid can be accepted by merging them, leaving an approving review, or by adding the “hacktoberfest-accepted” label.

We dislike seeing spam pull/merge requests just as much as you, so please give them a spam label and close them. Pull/merge requests that have a label containing the word spam won’t be counted toward Hacktoberfest, and participants with two or more PR/MRs identified as spam will be disqualified.

Please handle any other invalid contributions by closing them or labeling them as “invalid.”

Here are some additional tips to ensure your repository is Hacktoberfest-ready:

  • Project Goals: Make sure your repository has a well-defined purpose and clear goals. Document these in the README file so contributors understand the project's objectives. A well-maintained README, along with guides and examples, can make it easier for contributors to understand the codebase.
  • Useful Issue Templates: Create templates for various types of issues (e.g., bug reports, feature requests) to ensure that contributors provide necessary information when creating issues.
  • Useful Tags: Creating labels like “good first issue”, “beginner-friendly”, and “help wanted” are also good ways to draw attention to issues you’d like taken care of.
  • License Information: Ensure your project has a clear and open-source license. Without a license, contributors may be uncertain about how they can use and distribute the code.

Let it Shine 💫

Once your repository is set up and ready for new contributors, you're going to want to let them know that you exist.

One of the best ways to do this is on DEV! When you post about your project, use the official Hacktoberfest tag (#hacktoberfest23) to increase visibility. This would be a great time to share your project goals, values, and areas that you'd really like help from either beginners or veterans. You can use this Maintainer template to get started.

By sharing about your repo on DEV and being active during the month of October, you'll be eligible to earn the Hacktoberfest 2023 Honored Maintainer Badge.

Here are some other tips to boost the visibility of your project this month:

  • Update Project Activity: Keep your project active during Hacktoberfest by regularly merging and reviewing pull requests. An active project is more likely to attract contributors.
  • Use Socials and Email: Share announcements about your Hacktoberfest participation on your social media profiles. If you have an email list or newsletter, send out updates about your Hacktoberfest participation and any related events or opportunities.
  • Collaborate with Other Maintainers: Partner with other open-source project maintainers to cross-promote each other's repositories during Hacktoberfest.
  • Highlight Contributions: Acknowledge and celebrate contributions made during Hacktoberfest. Consider creating a "Contributors" section in your README to showcase the names or GitHub profiles of those who participated.

Remember that the goal of Hacktoberfest is to promote open-source collaboration and provide opportunities for people to contribute. Creating a positive and inviting environment in your repository will encourage participation and foster a sense of community among contributors.

Leave any other prep ideas or questions in the comments below!

Top comments (1)

Collapse
 
mridul_it_is profile image
Mridul Tiwari

can i maintain an organisation repository that I am member of will it be considered as a maintainer contribution