Skip to content

Commit b106978

Browse files
jaredgalanisJen Weber
authored andcommitted
readme.MD and contributing.MD review (#50)
* readme.MD and contributing.MD review - Adds a blurb about forking repo for first time contributors - Add link to github’s description of code fencing * add a comma
1 parent c4ead5a commit b106978

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ In code samples:
7979
* Follow the [Ember Style Guide](https://github.com/emberjs/ember.js/blob/master/STYLEGUIDE.md).
8080
* Use double-quotes in templates, i.e., `<div class="awesome">{{foo-bar title="Tomster"}}</div>`.
8181
* Omit the boilerplate that Ember CLI generates, especially the `import Ember from 'ember'` at the top of every file.
82-
* In fenced code blocks, write paths relative to the project root. e.g., `app/router.js`, `config/environment.js`
82+
* In [fenced code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/), write paths relative to the project root. e.g., `app/router.js`, `config/environment.js`
8383
* When writing a fenced code block with a filename, do so by writing the language name first followed by the file name within a data-filename block as shown below,
8484

8585
\`\`\` javascript {data-filename="app/router.js"}

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ computer. This repository, `guides-source` contains only written content
3939
as markdown files, which are fetched and displayed by
4040
[guides-app](https://github.com/ember-learn/guides-app).
4141

42+
Before following the below instructions and making any changes, first-time
43+
contributors should see [CONTRIBUTING.md](CONTRIBUTING.md) for
44+
instructions on forking the `guides-source` and `guides-app`
45+
repositories and making a first pull
46+
request.
47+
4248
```sh
4349
git clone git://github.com/ember-learn/guides-app.git
4450
git clone git://github.com/ember-learn/guides-source.git

0 commit comments

Comments
 (0)