You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+90-12Lines changed: 90 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,5 @@
1
+
# 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.
2
+
1
3
# Contributing to UI Grid
2
4
3
5
Please take a moment to review this document in order to make the contribution
@@ -10,18 +12,18 @@ patches and features.
10
12
11
13
## Developer guidelines
12
14
13
-
If you're a developer, please take a look at the [Developer guidelines](DEVELOPER.md)
15
+
If you're a developer, please take a look at the [Developer guidelines](DEVELOPER.md)
14
16
15
17
## Using the issue tracker
16
18
17
-
The [issue tracker](https://github.com/angular-ui/ng-grid/issues) is
19
+
The [issue tracker](https://github.com/angular-ui/ui-grid/issues) is
18
20
the preferred channel for [bug reports](#bugs), [features requests](#features)
19
21
and [submitting pull requests](#pull-requests), but please respect the following
20
22
restrictions:
21
23
22
24
* Please **do not** use the issue tracker for personal support requests (use
2. If you cloned a while ago, get the latest changes from upstream:
@@ -133,14 +140,85 @@ included in the project:
133
140
git pull [--rebase] upstream master
134
141
```
135
142
136
-
6. Push your topic branch up to your fork:
143
+
6. Squash your change into one commit
144
+
```bash
145
+
git rebase -i master
146
+
```
147
+
148
+
7. Push your topic branch up to your fork:
137
149
138
150
```bash
139
-
git push origin <topic-branch-name>
151
+
git push [--force] origin <topic-branch-name>
140
152
```
141
153
142
-
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
154
+
8.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
143
155
with a clear title and description.
144
156
145
157
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
146
-
license your work under the the terms of the [MIT License](LICENSE.md).
158
+
license your work under the terms of the [MIT License](LICENSE.md).
159
+
160
+
## <aname="commit"></a> Git Commit Guidelines
161
+
162
+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
163
+
readable messages** that are easy to follow when looking through the **project history**. But also,
164
+
we use the git commit messages to **generate the UIGrid change log**.
165
+
166
+
Alternatively you can install [commitizen](https://github.com/commitizen/cz-cli)**OR**
167
+
use the wizard. To use the wizard, run `npm run commit` in your terminal after staging your changes in git.
168
+
169
+
### Commit Message Format
170
+
**If you do not follow this style guide your commit message will fail to be created.**
171
+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
172
+
format that includes a **type**, a **scope** and a **subject**:
173
+
174
+
```
175
+
<type>(<scope>): <subject>
176
+
<BLANK LINE>
177
+
<body>
178
+
<BLANK LINE>
179
+
<footer>
180
+
```
181
+
182
+
The **header** is mandatory and the **scope** of the header is optional.
183
+
184
+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
185
+
to read on GitHub as well as in various git tools.
186
+
187
+
### Revert
188
+
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.
189
+
190
+
### Type
191
+
Must be one of the following:
192
+
193
+
***feat**: A new feature
194
+
***fix**: A bug fix
195
+
***docs**: Documentation only changes
196
+
***style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
197
+
semi-colons, etc)
198
+
***refactor**: A code change that neither fixes a bug nor adds a feature
199
+
***perf**: A code change that improves performance
200
+
***test**: Adding missing tests
201
+
***chore**: Changes to the build process or auxiliary tools and libraries such as documentation
202
+
generation
203
+
204
+
### Scope
205
+
The scope could be anything specifying place of the commit change. For example `core`,
Copy file name to clipboardExpand all lines: DEVELOPER.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ http://localhost:9003/docs/#/tutorial to browse each tutorial.
22
22
<br/> fast - alias for --no-e2e --core --angular=1.3.6
23
23
24
24
```
25
-
grunt dev --no-e2e --angular=1.3.6
25
+
grunt dev --no-e2e --angular=1.3.16
26
26
```
27
27
28
28
# Code Structure
@@ -32,16 +32,20 @@ The core angular module (ui.grid) provides the basics
32
32
- Virtualization
33
33
- Row Selection
34
34
35
-
Everything else should be added as new angular modules unless the grid team agrees that it's a core feature.
35
+
Everything else should be added as new angular modules unless the grid team agrees that it's a core feature. All new feature
36
+
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/)
37
+
about developing a plugin for ui-grid. Your plugin should use the available publicApi, if you need something in the publicApi that isn't
38
+
currently exposed, we welcome pull requests.
39
+
40
+
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
41
+
those features. In a future release we will be working to move some of the existing features out of the core repository. The basic
42
+
rule of thumb for any new features is: "If it is possible to implement it as a plugin, it should be a plugin".
36
43
37
44
## Feature module design
38
-
* We prefer no 3rd party dependencies other than angular. Contact grid team if you have a 3rd party need that can't be avoided.
45
+
* We prefer no 3rd party dependencies other than angular.
39
46
* jQuery is only used in Unit Tests
40
47
* unit test your code! not that hard. see test/unit for examples. Features will be rejected if the test coverage isn't adequate.
41
48
* use ngDoc to document how to use your feature. see examples in existing code.
42
-
* New module should be named ui.grid.feature
43
-
* feature folder is added below src
44
-
* One js file per feature
45
49
* no global variables
46
50
* public methods and events are registered in grid.api (more on that later)
47
51
* design and code the angular way. What do we mean by that? Dependency injection, small directives, emphasis the model, not the DOM, tests!
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.
2
+
3
+
-[ ] This is a bug report, not a question on how to use the grid.
4
+
Use [Stack Overflow](http://stackoverflow.com/questions/tagged/angular-ui-grid) or [Gitter](https://gitter.im/angular-ui/ui-grid) for questions.
5
+
-[ ] You have searched the open issues to see if this bug has been filed before. We don't want duplicate issues.
6
+
-[ ] You have reviewed the tutorials and documentation to ensure you are using the grid correctly. [ui-grid.info](http://ui-grid.info/docs/#/tutorial)
7
+
-[ ] You are using the latest version of the grid. Older versions are not patched or supported.
8
+
-[ ] You have provided steps to recreate your bug. A plunkr is even better.
0 commit comments