README.md

Race of Sloths Onboarding ☄️

Race of Sloths is a GitHub bot-user that helps open-source contributors collect Sloth Points while contributing to projects on GitHub.

1. Follow your regular GitHub flow: Create a regular PR (example)
2. Tag @race-of-sloths user in the description (or PR comment)
3. The user will respond to you and ask the repo maintainer to review your PR and score your PR
4. Now you are part of the Race! You are one of the Sloths (learn more about the irony behind the naming here)

Why?

It is a fun game to play with your fellow engineers Sloths and there are some thematic events with conference tickets giveaways, swag, and even money rewards.

Try it out in this repository! 🚀

Tip

Don't forget to mention @race-of-sloths in your PR description—it's all part of the process!

Choose your instructions below to get started with your contribution:

🖥️ Desktop Instructions

1. Fork the Repository

• Click the Fork button in the top-right corner of this page
• Confirm creating the fork
• Wait for the repository to be forked to your account

2. Add File With Your Name

• Create a file with [your-login].md
• Add your name to the file

- Your username

• The file should look like that:

• Scroll down and click Commit changes
  • Add a commit message: "Add [your-name] to the contributors list"
  • Select "Commit directly to the main branch"
  • Click "Commit changes"

3. Create Pull Request

• Go to the "Pull Requests" section
• Click the green "New Pull Request" button
• Add a title: "Add [your-name] to contributors list"
• Add @race-of-sloths to the description
• Click "Create Pull Request"

📱 Mobile Instructions

1. Fork the Repository

• Click the Fork button in the top left corner
• Confirm creating the fork
• Wait for the repository to be forked to your account

2. Add Your Name

• Tap the three dots icon. Click on "Create new file"
• Add your name into the file:

- Your username

• The file should look like that:

• Scroll down and tap "Commit changes"
  • Add the commit message
  • Select "Commit directly to the main branch"
  • Tap "Commit changes"

3. Create Pull Request

• Go to the "Pull Requests" section. You may need to click on three dots first.
• Click the green "New" button
• Add a title: "Add [your-name] to contributors list"
• Add @race-of-sloths to the description
• Click "Create Pull Request"

🌟 Bonus Points!

Want to test another cool feature? Follow these steps:

1. Visit our website and authorize with GitHub
2. Click on your avatar in the top right corner.
3. Copy your shareable snippet by clicking on "Copy Code" (it looks something like this):

4. Create a new file in the repository:

   • Name it [your-login]-snippet.md
   • Paste your copied snippet into the file

5. Create a PR just like before:

   • Use title: "Add [your-name]'s profile snippet"
   • Don't forget to mention @race-of-sloths in the description!

Did you know that you can customize your GitHub Profile page? It might look something like this

If you ever want to use it. Create a repo with your username and put the snippet in the README.md file.

Here is an example

✨ Tips for Success

• Follow the exact formatting shown above
• Only create new files
• Create only one PR for your contribution
• Be patient while waiting for review

Next Steps 🌟

Join Our Community

We're all over the place, and we want you to be, too!

• Reddit
• Telegram
• X (Twitter)
• GitHub

🤔 Need Help?

Reach out to us in Telegram chat

Your contributions—no matter how small—help shape the future. Let's make this happen. It's simple, it's fun, and we can't wait to see what you'll come up with!