Skip to content

Commit

Permalink
Update README.md and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Zirbel committed May 20, 2014
1 parent 15aea3c commit 1c47d97
Show file tree
Hide file tree
Showing 2 changed files with 205 additions and 25 deletions.
145 changes: 145 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Contributing to Ember Table

Looking to contribute something to Ember Table? Here's how you can help.

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.


## Using the issue tracker

The [issue tracker](https://github.com/Addepar/ember-table/issues) is
the preferred channel for [bug reports](#bug-reports),
[feature requests](#feature-requests) and
[submitting pull requests](#pull-requests), but please respect the following
restrictions:

* Please **do not** use the issue tracker for personal support requests. Stack
Overflow
([`ember-table`](http://stackoverflow.com/questions/tagged/ember-table) tag)
is a better place to get help.

* Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.


## Bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

1. **Use the GitHub issue search** — check if the issue has already been
reported.

2. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a reduced test
case and a live example. The starter kit JS Bin on the README page is a
helpful template.


## Feature requests

Feature requests are welcome. But take a moment to find out whether your idea
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.


## Pull requests

Good pull requests—patches, improvements, new features—are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code, porting to a different language),
otherwise you risk spending a lot of time working on something that the
project's developers might not want to merge into the project.

For now, pull requests aren't required to have tests. Once we've established
a testing infrastructure, pull requests that introduce new functionality should
come with tests for that functionality.

Adhering to the following process is the best way to get your work
included in the project:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/ember-table.git
# Navigate to the newly cloned directory
cd ember-table
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/Addepar/ember-table.git
```

2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
```

3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. 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:

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

6. 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/)
with a clear title and description against the `master` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the [BSD License](LICENSE).


## Running tests

Coming soon!


## Syntax:

* Two spaces, no tabs.
* No trailing whitespace. Blank lines should not have any space.
* a = b and not a=b.
* Follow the conventions you see used in the source already.


## License

By contributing your code, you agree to license your contribution under the
[BSD license](LICENSE).


#### NOTE: Largely copied from https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md
85 changes: 60 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,74 @@
# Ember Table by Addepar
# Ember Table

Table built using [Ember.js](http://emberjs.com/) that lazily renders rows.
A table built using [Ember.js](http://emberjs.com/) that lazily renders rows.

## Demo
Ember Table allows you to handle very large data sets by only rendering the
rows that are being displayed. It is written as an ember component with an API
that is easy to understand and extend.


## Demo and Documentation
http://addepar.github.com/ember-table/

## JS Bin Starter Kit
http://emberjs.jsbin.com/zozonuxu/1/edit

## Getting Started

### Take ember-table.js and modify it according to your liking with CSS.
#### JS Bin Starter Kit

### Compile with grunt (see http://gruntjs.com/getting-started)
```
http://emberjs.jsbin.com/zozonuxu/1/edit

#### Installation

With bower: `bower install ember-table --save`

Or, just include `dist/ember-table.js` and `dist/ember-table.css` in your app.

Once it's installed, you can customize the look of ember-table with CSS.

#### Developing or Testing

After cloning this repo, install dependencies and compile with grunt:

```bash
$ npm install -g grunt-cli
$ npm install
$ grunt
```

### Viewing Examples
From the root directory: `$ node examples.js`.
Hit up : `http://localhost:8000/examples`
To view examples, start the node server. From the root directory:

`$ node examples.js`.

You can view the examples at http://localhost:8000/gh_pages.

## Dependencies
* ember.js
* ember
* jquery-ui
* jquery.mousewheel.js
* antiscroll.js

## TODO
* Bug fixes—we are aware that there are bugs. Please help us out by filing github issues or submitting pull requests!
* Better documentation
* Unit tests
* Cell single and multi selection
* Better column drag and drop
* Support for colspan and rowspan
* Switch to ember/list-view for lazy rendering
* jquery.mousewheel
* antiscroll

## Contributing

Got something to add? Great! Bug reports, feature ideas, and (especially) pull
requests are extremely helpful, and this project wouldn't be where it is today
without lots of help from the community.

Please read the [contribution guidelines](CONTRIBUTING.md) for directions on
opening issues and working on the project.


## Versioning

Ember Table uses [Semantic Versioning](http://semver.org) to keep track of
releases using the following format:

`<major>.<minor>.<patch>`

In a nutshell, this means:
* Breaking changes to the API or behavior increases the major version
* Adding functionality in a backwards-compatible way increases the minor version
* Making backwards-compatible bug fixes increases the patch version


### Maintainers
Update version numbers and release using https://github.com/webpro/release-it. Install:
Expand All @@ -50,7 +82,10 @@ $ vim CHANGELOG.md
$ release <options>
```

### Copyright and License

## Copyright and License
Copyright © 2013 Addepar, Inc. All Rights Reserved

Licensed under the BSD License (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file.
Licensed under the BSD License (the "License"); you may not use this work
except in compliance with the License. You may obtain a copy of the License in
the LICENSE file.

0 comments on commit 1c47d97

Please sign in to comment.