/beginner-friendly-pr-bot

Tweeting beginner-friendly GitHub issues to help developers start their open source contribution journey.

Primary LanguageJavaMIT LicenseMIT

Beginner Friendly PR Bot

Bot Says Hi

Who am I?

This is me, and here's my twitter handle.

What do I do?

I tweet beginner-friendly GitHub issues to help developers start their open source contribution journey.

Who are you (the reader)?

  • Someone who is new to coding. ☺️
  • Someone who has been coding for a while, but has never contributed to open source projects. 😌
  • Neither of these and now wondering why are you here? 😳

How can I help you?

  • Follow me on Twitter.
  • Keep an eye out for various issues which I tweet.
  • Grab any issue which you like or find easy.
  • Make your first open source contribution.
  • And that's it! You did it. :bowtie:

That's one small step for [a] developer, one giant leap for open source community.

Contribute

There is always scope for improvement. Please create issues or pull requests if you want to make any changes.

Local Setup

Prerequisites

  1. Maven
  2. Java 8+

Running Locally

  1. Clone the repository. git clone https://github.com/calvincodes/beginner-friendly-pr-bot.git
  2. Change directory to the cloned repository. cd first-open-source-commit-bot
  3. Build the jar. mvn assembly:assembly -DdescriptorId=jar-with-dependencies
  4. Run the bot locally. java -jar target/first-open-source-commit-bot-1.0.0-SNAPSHOT-jar-with-dependencies.jar

References

Meet my friends

Acknowledgment

The image used was created by Irina Mir and can be found here.