search

osca-kip / community-starter-kit

https://lab.github.com/githubtraining/community-starter-kit
0 stars 0 forks source link

Add a repository description #2

Closed github-learning-lab[bot] closed 5 years ago

github-learning-lab[bot] commented 5 years ago

Step 2: Edit the README.md

:wave: @osca-kip, Mona has created a README and needs your help making it great. :sparkles:

Why you need a README.md

The README.md is the landing page for your project. It helps people understand, at a glance, whether your project is something that will be useful to them.

README.md files typically include information on:

Check it out

Mona's README.md is missing some of the information above. Will you help Mona by replacing the placeholder text?

:keyboard: Activity: Editing the README.md

  1. Access the Files changed tab in this pull request.
  2. Click the icon on the right of the file to edit the README.md.
  3. Find the two placeholder texts labeled DESCRIPTION PLACEHOLDER and FEATURES PLACEHOLDER. Replace them with some bulleted information that may be helpful to new users.
  4. After editing the README.md file, scroll down and click the Commit changes button.

Watch below for my response.

github-learning-lab[bot] commented 5 years ago

@osca-kip Writing a great :sparkles: project description can be intimidating. What do you think of something like this?

A GitHub App built with probot that celebrates new user activity within your repository.

If you agree this is ok, do you mind adding it to the README.md in this pull request where Mona put the placeholder?

:keyboard: Activity: Add a project description

  1. Access the Files changed tab in this pull request.
  2. Click the icon to the right of the file to edit the README.md.
  3. Find the text marked DESCRIPTION PLACEHOLDER and add the text recommended above.
  4. After editing the README.md file, scroll down and click the Commit changes button.

Watch below for my response.