Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a README #2

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create a README #2

wants to merge 2 commits into from

Conversation

github-learning-lab[bot]
Copy link

Step 2: Edit the README.md

👋 @VoterClopper, Mona has created a README and needs your help making it great. ✨

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:

  • What the project does
  • The features and benefits of the project
  • How users can get started with the project
  • Where users can get help with your project
  • Who maintains and contributes to the project

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!

⌨️ 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.


Welcome to **your** repository for your GitHub Learning Lab course. This repository will be used during the different activities that I will be guiding you through to learn about making your project friendlier for collaboration.
DESCRIPTION PLACEHOLDER
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Write a great description here or accept this suggested change.

Suggested change
DESCRIPTION PLACEHOLDER
A GitHub App built with [probot](https://github.com/probot/probot) that celebrates new user activity within your repository.


I'm the GitHub Learning Lab bot and I'm here to help guide you in your journey to learn and master the various topics covered in this course. I will be using Issue and Pull Request comments to communicate with you. In fact, I already added a pull request for you to check out.
FEATURES PLACEHOLDER
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Write your app's features here or accept this suggested change.

Suggested change
FEATURES PLACEHOLDER
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants