search

Lilmohawk4000 / community-starter-kit

One of many tutoriol repos
https://lab.github.com/githubtraining/community-starter-kit
0 stars 0 forks source link

Create a README #2

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

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

Step 2: Edit the README.md

:wave: @Lilmohawk4000, 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? I have suggested some changes below. Apply the suggested changes, or modify the file directly if you wish!

:keyboard: Activity: Editing the README.md

You can follow the manual steps below, or accept the suggested changes in the following comments.

  1. Edit README.md on this branch, or manually change it in the Files Changed tab.
  2. Find the two placeholder texts labeled DESCRIPTION PLACEHOLDER and FEATURES PLACEHOLDER.
  3. Replace each placeholder 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.

I'll respond when I detect a commit on this branch.

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

I was looking for you to replace the features placeholder, but it looks like it's still there. Marketing gave us a with a few bullets for the features (they are so good at this stuff). Here is what they recommended:

Welcome new users with maintainer defined comments the first time your users:

  • Create a new issue
  • Open a new pull request
  • Merge their first pull request

Do you mind adding it to the README.md in this pull request where Mona put the placeholder?

:keyboard: Activity: Add project features

You can accept the suggested changes, or make the change manually as follows:

  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 FEATURES PLACEHOLDER and add the text recommended above.
  4. After editing the README.md file, scroll down and click the Commit changes button.

I'll respond when I detect a commit on this branch.

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

Step 3: Approve and merge the pull request.

This README.md is looking great! Let's go ahead and merge it. There's a lot more to do!

:keyboard: Activity: Approve the pull request

  1. Clicking on this quicklink
  2. Select Approve
  3. Click Submit review.

You can also approve by clicking on Files changed, clicking on Review changes, selecting Approve and then Submit review.

I'll respond when you've approved this pull request.

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

The README.md is a great introduction, but some documentation will help users feel even more supported as they start using the app. Mona has created a draft. Can you help?

Check out the pull request.