Skip to content

Commit a1cb48c

Browse files
committed
update CONTRIBUTING and README
1 parent bbb183f commit a1cb48c

File tree

2 files changed

+85
-13
lines changed

2 files changed

+85
-13
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing
2+
3+
We would love to have your help with writing the next version of the ember-cli guides! As a work-in-progress, semi-greenfield project, it has different guidelines than other documentation projects. Once the project reaches MVP, these guidelines will change. Our target for MVP is the end of 2018.
4+
5+
## Ways to contribute
6+
7+
Developers of all knowledge and experience levels are invited to help out. Here are ways to contribute:
8+
9+
- Write new content
10+
- Migrate content over from [ember-cli.com](https://ember-cli.com/). Source code is [here](https://github.com/ember-cli/ember-cli.github.io)
11+
- Help review Pull Requests
12+
- Add comments to Markdown files with tips, resources, and notes to help others figure out what to write
13+
14+
## How to get started
15+
16+
1. See the [Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3) for a list of tasks that need help. Add a comment indicating which issue you can help with, then open an issue with the name of that task. Any Q&A for the task should go there. Contributors are encouraged to work in pairs.
17+
2. Read through the Styleguide below
18+
3. Open a Pull Request as soon as you'd like some feedback. This project aims to be "fast and good enough" rather than slower and perfect. Upon reaching MVP, a final pass will be made to polish content.
19+
4. Expect at least one round of revisions based on feedback from others
20+
21+
If you volunteer for a section but are not able to make progress, please speak up so that others may pick up where you left off. Issues that are inactive without response for 3 weeks may be opened up to new contributors.
22+
23+
## Leaving comments for other writers
24+
25+
This Guide is a team project! If you have an idea of the content
26+
that should be in a particular section, some useful resources on
27+
the topic, or even some incomplete explanations, you can add
28+
them as comments in the markdown. This is highly encouraged! We'll strip out comments when we reach MVP.
29+
30+
## Styleguide
31+
32+
33+
### Code Blocks
34+
35+
JavaScript and Handlebars files should follow the [Ember.js styleguide](https://github.com/emberjs/ember.js/blob/master/STYLEGUIDE.md).
36+
37+
Extending on these rules:
38+
39+
- Prefer arrow syntax (except for when scope matters, like computed properties. CPs should be noted that they can’t use arrow functions)
40+
- No var. Only const and let for variable declarations
41+
- Use brace expansion for imports, i.e. import { a, b } from @ember/somepackage and use the same name as is used in the API docs
42+
- Links to the API docs should point to the `/release/` version
43+
44+
### Writing
45+
46+
When in doubt, test your writing in [http://www.hemingwayapp.com/](http://www.hemingwayapp.com/)
47+
48+
#### Tone
49+
50+
Write in a welcoming, approachable way. Think of how you would explain something out loud. That’s the preferred tone - conversational and readable. Short sentences are good. Remember that many developers, this is their first framework and English is not their first language.
51+
52+
#### Audience of beginners
53+
54+
The audience is a developer who knows enough to have built a simple HTML/JavaScript (or JQuery) app. Explanations should appeal to both developers who are learning Ember as their first framework, but not be useless to people who know another framework.
55+
56+
#### Scope
57+
58+
Give enough information to form the mental models and show how things are connected. Ask yourself, what does someone need to know about this to build the MVP of their first app at work? How would I explain this to a Junior Developer in their first week at my workplace? Remember that the API docs should serve as the in-depth explanations. If the API docs are insufficient, PR there.
59+
60+
#### First person plural voice
61+
62+
Avoid voice altogether whenever you can. When some voice is needed, use first person plural (“we”, “our”, “let’s”)
63+
64+
65+
- Needs revision: “There is an entire ecosystem of adapters that allow our Ember app to talk to different types of servers…”
66+
- Better: “There is an entire ecosystem of adapters that allow our Ember app to talk to different types of servers …”
67+
- Best: “There is an entire ecosystem of adapters that allows Ember apps to talk to different types of servers …”
68+
69+
#### Inclusive language
70+
71+
“They/Them” is used in place of him/he/she/her/etc. Do not use gender in code examples. Avoid terms like “just, simply, obviously” etc.

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
## Ember-Cli Guides Source
22

3-
This repository is part of a Work-In-Progress project to refresh the CLI guides content that currently lives at [https://ember-cli.com](https://ember-cli.com). The [cli-guides-app](https://github.com/ember-learn/cli-guides-source) is the structure for the markdown files in this repository.
3+
This repository is part of a Work-In-Progress project to refresh and replace the CLI guides content of [https://ember-cli.com](https://ember-cli.com).
44

5-
As this project is pre-1.0, no content should be taken as the final word. Additional review is still pending.
5+
## Contributing
66

7-
Do you know a thing or two about the CLI or addons? We'd love to have your help with writing! Do you _wish_ you knew a thing or do? You could help us review to make sure that content is helpful to all knowledge levels. Please drop by the #-team-learning channel on the [Ember Community Slack](https://ember-community-slackin.herokuapp.com/) and `@` one of the [main contributors](https://github.com/ember-learn/cli-guides-source/graphs/contributors) to get more information.
7+
Do you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do? We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md).
8+
9+
Overall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.
10+
11+
As this project is pre-1.0, no content should be taken as technically authoritative.
812

913
## Prerequisites
1014

@@ -14,14 +18,7 @@ You will need the following things properly installed on your computer.
1418
* [Node.js](https://nodejs.org/) (with npm)
1519
* [Ember CLI](https://ember-cli.com/)
1620
* [Google Chrome](https://google.com/chrome/)
17-
18-
## Installation
19-
20-
* `git clone <repository-url>` this repository
21-
* `cd cli-guides-app`
22-
* `npm install`
23-
24-
This will display the content of the deployed Guides markdown
21+
* [npm](https://docs.npmjs.com/cli/install)
2522

2623
## Local Development
2724

@@ -33,10 +30,14 @@ To see what a local copy of the Guides markdown looks like:
3330
* Visit your app at [http://localhost:4200](http://localhost:4200).
3431
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
3532

33+
If you follow this strategy above, as you save changes to
34+
the markdown files of this repository, your locally served
35+
app should update.
36+
3637
### Adding more things to the table of contents
3738

38-
See `pages.yaml` in the cli-guides-source. Whatever has a url of index will be what is shown for the top level path, like `/tutorial/`. There must be an `index.md` under each topic.
39+
See `pages.yaml` in the cli-guides-source. Whatever has a url of index will be what is shown for the top level path, like `/tutorial/`. There must be an `index.md` under each topic.
3940

4041
### Deploying
4142

42-
See instructions on the [cli-guides-app](https://github.com/ember-learn/cli-guides-source) README.
43+
See instructions on the [cli-guides-app](https://github.com/ember-learn/cli-guides-app) README.

0 commit comments

Comments
 (0)