JasonEtco / communicating-with-github

MIT License
0 stars 0 forks source link

Welcome #1

Open galileo-dev-app[bot] opened 6 years ago

galileo-dev-app[bot] commented 6 years ago

Welcome to your repository!

This repository is all about communicating on GitHub. The first thing to know about communicating on GitHub is that Markdown is an easy and widely used way to format your text.

Later, we'll get into some other things, like Project boards, important documents like ISSUE_TEMPLATEs, crosslinking between issues, and more!

What is markdown?

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *. You can use markdown with the toolbar in issues and pull requests, or you can learn the simple syntax and type it yourself.

You can use Markdown most places around GitHub:

For more information, see “Writing on GitHub” in the GitHub Help.

Let's get started!

A Few Examples

Emoji
Emoji are fun :sparkles:, and they can be silly :stuck_out_tongue_winking_eye:, but they can also be an important communication tool when working with remote teams ✅. Tone doesn't come across as clearly when reading text as it comes speaking face to face, and emojis can be helpful in conveying context and emotions. :heart: Here are some examples of popular emojis in markdown. | What you see | What you type | | ---------- | ------------ | | :heart: | `:heart:` | | :+1: | `:+1:` | | :smile: | `:smile:` | | :sparkles: | `:sparkles:` | | :tada: | `:tada:` | If you aren't sure what emojis are possible, you can [look them up on a cheatsheet](https://gist.github.com/rxaviers/7360908). In many places on GitHub, you can type `:` and then begin to type the name of an emoji. A fuzzy search will bring up the 5 best guesses and let you select one. ![image of fuzzy search emojis on GitHub](https://user-images.githubusercontent.com/9906718/34602228-47cab148-f1ff-11e7-91f1-56d0fed702f0.png)
Header
An example of a header is, well, the header at the beginning of this issue! Just like in any text editing software, a header is a larger bit of text at the beginning of a section. ``` # This is an

tag ## This is an

tag ###### This is an

tag ``` The fewer the `#`, the larger the header.
Emphasis
You can also use **bold** and _italic_ text in markdown. In markdown, sometimes there are multiple ways to accomplish the same goal. ``` *This text will be italic* _This will also be italic_ **This text will be bold** __This will also be bold__ _You **can** combine them_ ```
Links
Creating links is important when communicating in issues and pull requests. Sometimes, you may want to link to a [website](https://github.com/), a [repository](https://github.com/github/training-kit), or even a [line of code](https://github.com/github/training-kit/blob/master/resources/learning-path/index.html#L32). But long URLS are not easy on the eyes. To create a link, put the text you want to display in the square brackets, and the URL in the following parenthesis. ``` [GitHub](http://github.com) ```

First Assignment

  1. Leave a comment to this issue. Use markdown. Include all of the following:
    • At least 1 emoji
    • Any type of header
    • Bold or italics
    • A link to your GitHub profile (like http://github.com/USERNAME)

Good luck!

JasonEtco commented 6 years ago

header

dsfadfsa

https://github.com/jasonetco

galileo-dev-app[bot] commented 6 years ago

Congratulations, you've done it!

Next, let's learn some more markdown and get a little more practice.

More Markdown

Lists

Ordered Lists
Ordered lists have numbers and can have indented children that are also ordered. When you're creating ordered lists, you can type out the exact number you want to show in order, (1, 2, 3, etc.) but you can also type every number as "1.". Markdown will take care of the rest of the numbering for you, and your list will be easier to maintain. ``` 1. Item 1 1. Item 2 1. Item 3 1. Item 3a 1. Item 3b ``` 1. Item 1 1. Item 2 1. Item 3 1. Item 3a 1. Item 3b
Unordered Lists
To create an unordered list, you can use the `-` character or the `*` character. To do an indented child list item, you need to type a tab or at least two spaces. ``` * Item 1 * Item 2 * Item 2a * Item 2b ``` * Item 1 * Item 2 * Item 2a * Item 2b
Task Lists
A task list creates checkboxes that can be checked off by collaborators in a given repository. They're very handy for tracking issues, pull requests, and any to-do item. If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests! Watch out, because the syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't work. ``` - [x] Other markdown is supported, including @mentions, #refs, [links](), **formatting**, and tags - [x] list syntax required (any unordered or ordered list supported) - [x] this is a complete item - [ ] this is an incomplete item ``` - [x] @mentions, #refs, [links](), **formatting**, and tags supported - [x] list syntax required (any unordered or ordered list supported) - Like this - [x] this is a complete item - [ ] this is an incomplete item

Code Blocks

Inline Code Blocks
Sometimes, it makes text easier to read if you specify a certain term as `code`. The word "code" in the previous sentence was distinguished in markdown with `inline code blocks`. Inline code is just one ``` character on either side of the text, and can be used within paragraphs, headers, or other markdown. ``` `inline code is just one backtick` ``` `inline code is just one backtick`
Separate Code Blocks
If you need to separate out a larger block of code, use three ``` characters instead of one, and set the text aside in its own paragraph. This is how the course shows you how markdown looks without actually formatting it. ``` Anything put in this **paragraph** will not be _formatted_ even if it would normally be recognized in this setting. :taco: ``` Anything put in this **paragraph** will not be _formatted_ even if it would normally be recognized in this setting. :taco:
Syntax Highlighting
In addition to code blocks, you can specify how the code should be formatted by language. For example, take a look at this JavaScript code in a regular code block: What we type: ``` function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } } ``` What we see: ``` function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } } ``` But, when we add the language after the first three ``` characters, the formatting is specific to the programming language. What we type: ```javascript function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } } ``` What we see: ```javascript function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } } ```

Activity

  1. Comment again, using at least two of the following:
    • ordered list
    • unordered list
    • task list
    • inline code block
    • separate code block
beardofedu commented 6 years ago
  1. hello
  2. to
  3. you
JasonEtco commented 6 years ago
  1. hello
  2. to
  3. you