README

Adding a README.md

So, you've got your new repository, and you've initiated it with a README.md file. Let's make this a hello-world file. Good practice is to include a README.md to describe what you've got in your repo.

---

Note If you've already made a README.md file, open it and skip to Step 5

If you haven't let's make and commit a README.md file.
So, what is a README?

A text file containing information about the files in a repository that is typically the first file a visitor to your repository will see. A README file, along with a repository license, contribution guidelines, and a code of conduct, helps you share expectations and manage contributions to your project.

How To:

2. Click "Add file" and "Create new file"
3. Type README.md and press enter
4. Click on the "file contents" textbox

Warning If you can't type in it, click the pen icon, or press E on your keyboard

5. Enter your Markdown code into the file.

Note Have no clue what Markdown is? Refer to our explanation, and have a look at this Syntax Guide

6. Click Preview to check everything works

7. Once finished, click "Commit changes..."

8. Detailing your commit

Name the main title of your change Describe what you changed Select "Create a new branch for this commit and start a pull request" Once finished, click "Propose changes"

9. Click "Create Pull Request"

10. Click "Merge pull request"

WARNING It's important to note here that if the branch has conflicts, GitHub will either try to resolve them or ask you to choose which code you want to keep, or a combination of the two. It's best to work one at a time to prevent conflicting PRs

11. Click "Delete branch"

Note Here, we're deleting the branch that held our code temporarily, so our repository is cleaner and future branches stem off of your main so don't cause major conflicts.

All done! You've created your first Pull request (one of many to come!)

Next, we're going to learn about Issues and what they're used for (& how to create them!)

-> Next