Coder Social home page Coder Social logo

community-starter-kit's Introduction

  • ๐Ÿ‘‹ Hello World, Iโ€™m Ajay Dev aka @RamesanPP
  • Experimenting.. Existing!. ๐Ÿ“
  • Titles don't mean anything to me. That's why I don't display any. ๐Ÿ‘พ
  • ๐Ÿค– Currently excited by the AI buzz ๐Ÿ˜‰
  • BACKEND ๐Ÿ‘จ๐Ÿพโ€๐Ÿ’ป

community-starter-kit's People

Contributors

a-a-ron avatar beardofedu avatar github-learning-lab[bot] avatar githubteacher avatar hectorsector avatar ramesanpp avatar

Stargazers

 avatar

Watchers

 avatar

community-starter-kit's Issues

Make it visible

Step 15: Help users find the project

GitHub uses repository topics to help people find projects that might be of interest based on their search patterns or the projects they are working on.

Mona would like to add a few topics to this repository. Can you help her out?

โŒจ๏ธ Activity: Adding Topics to the repository

  1. On the Code tab, click the gear icon located next to the About section of the repository and just above the repository description.
  2. In the Topics field, type the first topic Probot. GitHub might also have some Suggested topics for this repository.
  3. After entering a topic (or topics), click Done.

Close this issue when finished.

๐Ÿค– I'm waiting for you to close this issue

Preparing Mona's project for open source

Meet Mona

Monalisa octocat: the original

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.

Add an issue template

Understanding contributors

Most contributors take a gradual path to getting involved in an open source community. It usually looks something like this:

  1. Reporting a bug
  2. Suggesting a new feature
  3. Creating a pull request

More seasoned open source contributors might go straight to creating their first pull request, so adding helpful templates to a repository that makes it easier for everyone to get involved, regardless of their previous experience.

Step 6: Adding an issue template

When you add an issue template and pull request template to your repository, project contributors will automatically see the template's contents when they open a new issue or pull request. Templates help you standardize the information you'd like included when contributors open issues.

GitHub offers standard templates for bug reports and for feature requests. We'll utilize those here.

๐Ÿ“– GitHub help docs: Configuring issue templates for your repository

Creating multiple templates

In open source projects, templates make it easy for new contributors to create bug reports, suggest new features, or contribute changes. Can you put one together for bugs?

โŒจ๏ธ Activity: Adding an issue template

GIF showing a click on the repository's settings tab, scrolling down, clicking on set up templates, selecting a bug report template, a feature request template, and a custom template. Then, clicking on propose changes, changing the branch name to templates, and then committing. Finally, a new PR shows up.

  1. Access this quicklink for templates or manually navigate to it as follows:
    • Click on your repository's Settings tab.
    • Scroll down to the Features section
    • Click on Set up templates
  2. Click on Add a template: select
  3. Select the bug report template.
    • Feel free to add more than one template, or create custom templates.
  4. Click Propose changes
  5. Enter a commit message, choose a name for your branch, and click Commit changes. GitHub will create a new pull request titled Update issue templates for you.

I'll respond when I detect a new pull request titled Update issue templates.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.