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.

Sign up for GitHub

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

Update contributing guidelines #242

Merged
merged 1 commit into from
Jan 6, 2015
+23 −4
Merged

Update contributing guidelines #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,19 @@ fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.

## Writing Code in Ember Table

Ember-table is written in [CoffeeScript](http://coffeescript.org/) and compiled
into JavaScript using [Grunt](http://gruntjs.com/). Contributing to ember-table
requires that you have grunt and NPM (for pulling in dependencies) locally
installed.

The `src` folder contains all the source code for the ember-table project
itself. The `app` folder contains the sample app and documentation, and should
be updated whenever changes will add functionality, modify or remove existing
functionality, or change public APIs. The `dist` folder contains the compiled
ember-table code and should not be directly modified but instead generated using
`grunt dist`.

## Pull requests

Expand Down Expand Up @@ -98,25 +111,31 @@ included in the project:
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit
4. Before committing changes, make sure to compile modified CoffeeScript files.

```bash
grunt dist
```

5. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:
6. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream master
```

6. Push your topic branch up to your fork:
7. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `master` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
Expand Down