Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
Conflicts:
	src/js/core/factories/GridColumn.js
	src/templates/ui-grid/ui-grid-filter.html
  • Loading branch information
MaksimSimkin committed Sep 20, 2016
2 parents 10abe8b + 4cbacdb commit f8af72a
Show file tree
Hide file tree
Showing 231 changed files with 44,123 additions and 3,283 deletions.
1 change: 0 additions & 1 deletion .gitignore
Expand Up @@ -118,7 +118,6 @@ DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish

# Others
[Bb]in
Expand Down
3 changes: 2 additions & 1 deletion .travis.yml
Expand Up @@ -2,7 +2,7 @@ language: node_js
sudo: false # defaults to sending build to container-based infrastructure on Travis

node_js:
- '0.10'
- 4

notifications:
webhooks:
Expand Down Expand Up @@ -31,6 +31,7 @@ branches:
only:
- master
- /^3\.0$/
- /^3\.x$/
- /^release-.*$/

before_install:
Expand Down
310 changes: 310 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

102 changes: 90 additions & 12 deletions CONTRIBUTING.md
@@ -1,3 +1,5 @@
# New Issues are for bug reports or feature requests only!! Questions on how to use the grid should be posted to Stack Overflow or Gitter https://gitter.im/angular-ui/ui-grid.

# Contributing to UI Grid

Please take a moment to review this document in order to make the contribution
Expand All @@ -10,18 +12,18 @@ patches and features.

## Developer guidelines

If you're a developer, please take a look at the [Developer guidelines](DEVELOPER.md)
If you're a developer, please take a look at the [Developer guidelines](DEVELOPER.md)

## Using the issue tracker

The [issue tracker](https://github.com/angular-ui/ng-grid/issues) is
The [issue tracker](https://github.com/angular-ui/ui-grid/issues) is
the preferred channel for [bug reports](#bugs), [features requests](#features)
and [submitting pull requests](#pull-requests), but please respect the following
restrictions:

* Please **do not** use the issue tracker for personal support requests (use
[Stack Overflow](http://stackoverflow.com/questions/tagged/ng-grid)
or IRC).
[Stack Overflow](http://stackoverflow.com/questions/tagged/angular-ui-grid) ( [Old Tag](http://stackoverflow.com/questions/tagged/ng-grid))
or our [Gitter Chat](https://gitter.im/angular-ui/ui-grid)).

* Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.
Expand Down Expand Up @@ -74,7 +76,8 @@ Example:
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.
provide as much detail and context as possible. Please also see the note in the
[Developer guidelines](DEVELOPER.md) about implementing new features as plugins.


<a name="pull-requests"></a>
Expand All @@ -92,6 +95,10 @@ project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation,
accurate comments, etc.) and any other requirements (such as test coverage).

**Include Examples** If possible, include links to a youtube video or GIF
demonstrating your fix or your feature. It will help us understand what you
are doing and why we want to merge it in.

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

Expand All @@ -100,11 +107,11 @@ included in the project:

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

2. If you cloned a while ago, get the latest changes from upstream:
Expand Down Expand Up @@ -133,14 +140,85 @@ included in the project:
git pull [--rebase] upstream master
```

6. Push your topic branch up to your fork:
6. Squash your change into one commit
```bash
git rebase -i master
```

7. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
git push [--force] 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.

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

## <a name="commit"></a> Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to **more
readable messages** that are easy to follow when looking through the **project history**. But also,
we use the git commit messages to **generate the UIGrid change log**.

Alternatively you can install [commitizen](https://github.com/commitizen/cz-cli) **OR**
use the wizard. To use the wizard, run `npm run commit` in your terminal after staging your changes in git.

### Commit Message Format
**If you do not follow this style guide your commit message will fail to be created.**
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:

```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

The **header** is mandatory and the **scope** of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on GitHub as well as in various git tools.

### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

### Type
Must be one of the following:

* **feat**: A new feature
* **fix**: A bug fix
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
semi-colons, etc)
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **perf**: A code change that improves performance
* **test**: Adding missing tests
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
generation

### Scope
The scope could be anything specifying place of the commit change. For example `core`,
`infinite-scroll`, `pagination`, `cellnav`, `edit`, `importer`, `pinning`, etc...

### Subject
The subject contains succinct description of the change:

* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize first letter
* no dot (.) at the end

### Body
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.

### Footer
The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

16 changes: 10 additions & 6 deletions DEVELOPER.md
Expand Up @@ -22,7 +22,7 @@ http://localhost:9003/docs/#/tutorial to browse each tutorial.
<br/> fast - alias for --no-e2e --core --angular=1.3.6

```
grunt dev --no-e2e --angular=1.3.6
grunt dev --no-e2e --angular=1.3.16
```

# Code Structure
Expand All @@ -32,16 +32,20 @@ The core angular module (ui.grid) provides the basics
- Virtualization
- Row Selection

Everything else should be added as new angular modules unless the grid team agrees that it's a core feature.
Everything else should be added as new angular modules unless the grid team agrees that it's a core feature. All new feature
modules should be developed as plugins, and be hosted in their own repositories. There is a great [blog post](http://brianhann.com/write-your-own-ui-grid-plugin/)
about developing a plugin for ui-grid. Your plugin should use the available publicApi, if you need something in the publicApi that isn't
currently exposed, we welcome pull requests.

The grid team has limited time to spend on this project, and as the list of features grows, so does the effort required to support
those features. In a future release we will be working to move some of the existing features out of the core repository. The basic
rule of thumb for any new features is: "If it is possible to implement it as a plugin, it should be a plugin".

## Feature module design
* We prefer no 3rd party dependencies other than angular. Contact grid team if you have a 3rd party need that can't be avoided.
* We prefer no 3rd party dependencies other than angular.
* jQuery is only used in Unit Tests
* unit test your code! not that hard. see test/unit for examples. Features will be rejected if the test coverage isn't adequate.
* use ngDoc to document how to use your feature. see examples in existing code.
* New module should be named ui.grid.feature
* feature folder is added below src
* One js file per feature
* no global variables
* public methods and events are registered in grid.api (more on that later)
* design and code the angular way. What do we mean by that? Dependency injection, small directives, emphasis the model, not the DOM, tests!
Expand Down
16 changes: 7 additions & 9 deletions FIRST_TIMER.md
Expand Up @@ -31,7 +31,7 @@ In order to contribute an update your basic process is:
can work, and over which you have access permissions
- Clone that repository
- Setup the toolset on your local machine
- Make the documentation changes, and verify that they look at you had hoped
- Make the documentation changes, and verify that they look as you had hoped
- Run the tests to check that nothing has broken
- Commit the code to git, and push the branch to your fork
- Create a pull request from your fork to the upstream repository
Expand All @@ -40,11 +40,9 @@ We'll go through each step in turn.

### Fork the ui-grid repository ###
This is the easiest step. Get yourself a github logon, and navigate to the
[ui-grid github page](https://github.com/angular-ui/ng-grid). Note that the
actual repository still goes by the old project name of ng-grid. Click the
[ui-grid github page](https://github.com/angular-ui/ui-grid). Click the
fork button in the top left. This should navigate you to your list of
projects in github, with a new fork of ui-grid (also called ng-grid in your
repository list).
projects in github, with a new fork of ui-grid.

You'll see that this gives you your own issue tracker and a bunch of other content.
In general you'll ignore all this, and you'll just use your fork for submitting
Expand Down Expand Up @@ -79,8 +77,8 @@ inside it, within the .git folder.

We also want to setup a link to the upstream repository, which we use when fetching
the latest code version:
` cd ng-grid`
` git remote add upstream https://github.com/angular-ui/ng-grid.git`
` cd ui-grid`
` git remote add upstream https://github.com/angular-ui/ui-grid.git`

This allows you to get the latest code from upstream by:
` git fetch upstream` or
Expand Down Expand Up @@ -203,7 +201,7 @@ Look through the diff listing to verify that only the changes you expected are p
To commit to git, you can:
` git add .`
` git commit`
In your commit message, follow the guidelines from [CONTRIBUTING.md](https://github.com/angular-ui/ng-grid/blob/master/CONTRIBUTING.md):
In your commit message, follow the guidelines from [CONTRIBUTING.md](https://github.com/angular-ui/ui-grid/blob/master/CONTRIBUTING.md):

- 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.
Expand Down Expand Up @@ -232,7 +230,7 @@ This will give you an error message, but also tell you what the real instruction
copy and paste:
` git push --set-upstream origin 1023_nulls_to_custom_sort`

Now go to your homepage in git, and to your fork of the ng-grid repository. You should see a message saying
Now go to your homepage in git, and to your fork of the ui-grid repository. You should see a message saying
that a new branch has been pushed, and asking if you want to create a pull request. Click that button,
and check the list of changes again in the commit history, and that there is a good quality commit
message with only a single commit.
Expand Down
8 changes: 8 additions & 0 deletions ISSUE_TEMPLATE.md
@@ -0,0 +1,8 @@
Please make sure each of the following is true before submitting a new issue. We are a small team with limited time and it is very difficult to manage issues if they aren't reported correctly.

- [ ] This is a bug report, not a question on how to use the grid.
Use [Stack Overflow](http://stackoverflow.com/questions/tagged/angular-ui-grid) or [Gitter](https://gitter.im/angular-ui/ui-grid) for questions.
- [ ] You have searched the open issues to see if this bug has been filed before. We don't want duplicate issues.
- [ ] You have reviewed the tutorials and documentation to ensure you are using the grid correctly. [ui-grid.info](http://ui-grid.info/docs/#/tutorial)
- [ ] You are using the latest version of the grid. Older versions are not patched or supported.
- [ ] You have provided steps to recreate your bug. A plunkr is even better.

0 comments on commit f8af72a

Please sign in to comment.