imsubhamsingh / imsubhamsingh/community-starter-kit
Preparing Mona's project for open source
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Meet Mona
Mona is part of a growing team of developers. To help onboard new teammates, Mona has created a slick [Probot](https://probot.github.io/) 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](https://probot.github.io/) 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 :heart: welcome
We want to thank the maintainers of [**welcome-bot**](https://github.com/behaviorbot/welcome), 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](https://github.com/behaviorbot).
Keep reading below to find your first task
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start with the issue's Our Goals list and determine which project guidance and contribution systems are required; the work is done when the Welcome-bot repository is understandable, discoverable, and ready for community contributions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100