Join us for office hours !

First Timers

Create starter issues to help onboard new open source contributors
Screenshot of First Timers app

Repository

hoodiehq/first-timers-bot

Authors

agonzalez0515

Techforchange

Updated

December 13, 2017

Used By

jekyll processing Moya hoodiehq skywinder semantic-release mikaelbr terkelg gr2m db-migrate

first-timers-bot

๐Ÿถ๐ŸŽฏโ›ณ The Motivation

From our own experiences, we know the process of creating a pull request is the biggest barrier for new contributors. We wanted to streamline the process to create very simple contributor-friendly issues to help onboard more people to become Open Source contributors for the first time.

At Hoodie, we aim to become the most welcoming Open Source community possible. We joined forces with initiatives like First Timers Only and Your First PR to actively reach out to new contributors and create an environment where they feel encouraged and supported.

Creating what we call starter issues is one aspect of that. And it is one of the most successful. A subset of these starter issues are super simple fixes like typos, so they are perfect to onboard people and help them get familiar with GitHub and the pull request workflow. Because typos and similar issues are so trivial, we should basically be able to automatically generate the entire starter issue based on a diff.

๐Ÿ’ก๐Ÿ’ฅโ“ How things work

Say Iโ€™m a Hoodie contributor and find a typo somewhere. Instead of fixing the issue directly in the master branch or creating a pull request which is time-consuming, I can simply create a new branch that is called something like first-timers-typo-in-title. GitHub will then notify the First Timers Bot about the new branch using Webhooks. The bot is listening to any new branch starting with first-timers and it will create a new issue on your repo. The commit body can be used to add some context information and if left empty, the ๐Ÿค” What you will need to know section of the issue will simply say โ€œNothing :)โ€.

๐Ÿ˜ฎ๐Ÿ™Œ๐Ÿ‘€๐ŸŽ‰ Use Our Bot!

Steps Example
1) Install App on a repo of your choice Install App
2) Click on the file you want to edit. Edit Pic
3) Make the change and write your commit message under Commit changes. Make sure to check Create a new branch at the bottom and the branch needs to start with "first-timers-". Committing Branch
4) Click on the issues tab and notice your issue was created with your change and commit message. The contributor would then follow the steps on the issue message. Issue Generated

๐Ÿ˜ฑ๐Ÿ™Œ๐Ÿ˜Ž Result

Issue Example Here

Issue Done

๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ’•About Us

Angie Gonzalez

Angie Gonzalez
Arlene Perez

Arlene Perez

Angie and Arlene are LA natives that met while attending Dev Bootcamp in San Francisco. After bootcamp was over and they were back in LA, they wanted to once again be part of an amazing, welcoming community like DBC was. They found Hoodie through Rails Girls Summer of Code! This project is extra special for them as it is their first contribution to open source.

Contributors

Thank you to everyone who has helped with this project.

Michael McCombie

Michael McCombie
๐ŸŽจ
Gregor Martynus

Gregor Martynus
๐Ÿ‘จ๐Ÿปโ€๐Ÿซ

This project follows the all-contributors specification.

License

Apache 2.0

Get occasional updates on new apps & features.

Star

with by @bkeepers

Code licensed ISC Docs licensed CC-BY-4.0