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

Add a repository description #2

Merged
merged 3 commits into from
Nov 24, 2018
Merged

Add a repository description #2

merged 3 commits into from
Nov 24, 2018

Conversation

github-learning-lab[bot]
Copy link

Step 2: Edit the README

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

Why you need a README

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 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 is missing some of the information above. Will you help Mona by replacing the placeholder text?

⌨️ Activity: Editing the README

  1. Access the Files changed tab in this pull request
  2. Click the ✏️ pencil icon to edit the README
  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 file, scroll down and click the Commit changes button.

Watch below for my response

@github-learning-lab
Copy link
Author

Step 3: Merge the README

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

⌨️ Activity: Merge the pull request

  1. Click Merge pull request
  2. Click Confirm merge
  3. Click Delete branch

Watch below for my response

@JoseCage JoseCage merged commit fb9e726 into master Nov 24, 2018
@github-learning-lab
Copy link
Author

The README 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!

@JoseCage JoseCage deleted the add-readme branch November 24, 2018 02:55
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

3 participants