Skip to content
This repository was archived by the owner on Feb 2, 2025. It is now read-only.

Commit 096f817

Browse files
committed
Add CONTRIBUTING.md
1 parent 5a4244a commit 096f817

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Contributing
2+
============
3+
4+
1. Fork this project and install the dependencies:
5+
```
6+
npm install
7+
```
8+
2. Create a new feature/patch branch or switch to the `dev` branch.
9+
3. Code your feature/bug fix and live up to the current code standard:
10+
* Not violate [DRY](http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself)
11+
* [Boy scout rule](http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule) should be applied
12+
* The code must be well documented
13+
* Add tests
14+
4. Run `grunt` to build the minified files.
15+
5. Write a nice [commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
16+
6. [Pull request](https://help.github.com/articles/using-pull-requests) using the new feature/patch branch
17+
7. Ensure the [Travis build](https://travis-ci.org/l-lin/angular-datatables) passes
18+
19+
20+
If you need to see the result of your feature/bug fix on the demo, you can launch the node server by
21+
executing the following command and access to [http://localhost:3000/angular-datatables](http://localhost:3000/angular-datatables)
22+
```
23+
grunt serve
24+
```

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,11 @@ $scope.$on('event:dataTableLoaded', function(event, loadedDT) {
9696
* `Angular Datatables` is using [Object.create()](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Objets_globaux/Object/create) to instanciate options and columns.
9797
* If you need to support IE8, then you need to add this [Polyfill](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/create#Polyfill).
9898

99+
Contributing
100+
============
101+
102+
See [https://github.com/angular/angular.js/blob/dev/CONTRIBUTING.md].
103+
99104
License
100105
================
101106
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

0 commit comments

Comments
 (0)