diff --git a/_apps/first-timers-bot.md b/_apps/first-timers-bot.md new file mode 100644 index 0000000..444e48c --- /dev/null +++ b/_apps/first-timers-bot.md @@ -0,0 +1,88 @@ +--- +title: First Timers Bot +description: A friendly bot that helps with onboarding new Open Source Contributors +slug: first-timers-bot +screenshots: +- https://raw.githubusercontent.com/hoodiehq/first-timers-bot/master/assets/Issue-Done.png +author: agonzalez0515 & ArlenePerez +stars: 10 +repository: hoodiehq/first-timers-bot +updated: 2017-09-11 10:43:30 UTC +--- + +# first-timers-bot + +[![Build Status](https://travis-ci.org/hoodiehq/first-timers-bot.svg?branch=master)](https://travis-ci.org/hoodiehq/first-timers-bot)[![Greenkeeper badge](https://badges.greenkeeper.io/hoodiehq/first-timers-bot.svg)](https://greenkeeper.io/) + +### 🐶🎯⛳ 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](http://hood.ie/blog/welcoming-communities.html). We joined forces with initiatives like [First Timers Only](http://www.firsttimersonly.com/) and [Your First PR](http://yourfirstpr.github.io/) to actively reach out to new contributors and create an environment where they feel encouraged and supported. + +Creating what we call [starter issues](http://hood.ie/blog/starter-issues.html) 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-only-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-only** and it will create a new issue on your repo. It is currently setup to the Hoodie repo with a template and assigns the first-timers-only and up-for-grabs labels but can be modified by the developer. 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! + + + + + + + + + + + + + + + + + + + + + +
StepsExample
1) Install App on a repo of your choice
2) Click on the file you want to edit.
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-".
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. +
+ +### 😱🙌😎 Result + +[Issue Example Here](https://github.com/arlene-perez/bot-app-test/issues/1) + +

+ +### 👩‍💻💕About Us + + +| Angie Gonzalez
[Angie Gonzalez](https://agonzalez0515.github.io)
| Arlene Perez
[Arlene Perez](https://github.com/techforchange)
| +| :---: | :---: | + + +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](https://railsgirlssummerofcode.org/)! 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](https://twitter.com/michaelbuilds)
[🎨](https://raw.githubusercontent.com/hoodiehq/first-timers-bot/51742c62ae3e4e2be7e58d170a9eab73a3871bf4/assets/avatar.png) | Gregor Martynus
[Gregor Martynus](https://twitter.com/gr2m)
👨🏻‍🏫 | +| :---: | :---: | + +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. + +### License + +[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)