Preparing Mona's project for open source
Closed this issue · 3 comments
Meet Mona
Mona is part of a growing team of developers. To help onboard new teammates, Mona has created a slick Probot app called Welcome. Welcome automatically generates friendly messages when new team members create their first issue and open or merge their first pull request.
So far, Mona has been working with a few members of the team to fine-tune the app, but someone recommended they make the project open source so that other projects can start creating the same awesome experiences for first timers. Mona has never published an open source project before, so after receiving the OK from legal, Mona is looking for some help.
In this course, you will help Mona get the Welcome-bot repository ready for the open source community.
What is Probot
Great question! Probot is an open source framework that allows you to create GitHub apps to automate your GitHub workflow. Probot is also an example of a great community - be sure to stop by and check them out.
Our Goals
In this course, you will work with Mona to:
- Help others understand how they can use Mona's project
- Recognize the ways people may contribute
- Establish systems to organize contributions
- Set expectations for contributors
- Make Mona's project easy to find
We ❤️ welcome
We want to thank the maintainers of welcome-bot, an actual Probot app that welcomes new users, for graciously allowing us to use their awesome app for this course. After your open source project is up and running, we recommend you check out welcome and some of the other bots created by the developers of behaviorbot.
Keep reading below to find your first task
Step 1: Add a Repository Description
First, let's focus on helping others understand Mona's project. After all, people are most likely to contribute to projects they use, so no users === no contributors.
Users should be able to understand the project at a glance, so let's start by adding a repository description and creating a README.
Mona is working on a first draft of the README. Can you help by adding a description to the repository?
⌨️ Activity: Adding a repository description
- Access the Code tab of your project.
- Click the Edit button located on the right side of the screen (above the green Clone or download button).
- Enter a description for your project in the Description field.
- (Optional) If you have a website related to your project you can add it in the Website field.
- Click the Save button.
- When you are finished, go ahead and close this issue.
Protip If you are working in a public repository, GitHub has created a helpful Community profile in the insights tab. The Community profile has helpful quick-links to complete many of the tasks in this course.
Watch for my response below
🤖 I'm waiting for you to close this issue
🤖 Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds and refresh the page for your next steps.
L2: Closed issue
Great work, @rohan-git! Mona has finished the first draft of the README and has opened a pull request. Head over there now to see what's next.