File tree Expand file tree Collapse file tree 1 file changed +64
-1
lines changed Expand file tree Collapse file tree 1 file changed +64
-1
lines changed Original file line number Diff line number Diff line change 1
- # Contributing
1
+ # Contributing Guide
2
+
3
+
4
+ ## Dependencies
5
+
6
+ To make sure that the following instructions work, please install the following dependencies on your machine:
7
+
8
+ * Node.js (used v0.12.7, not tested on v4+)
9
+ * npm
10
+ * bower
11
+ * gulp (globally)
12
+ * Git
13
+
14
+ ## Installation
15
+
16
+ Get the source by clonning the git repository:
17
+
18
+ ```
19
+ $ git clone https://github.com/igorissen/angular-link-header-parser.git
20
+ ```
21
+
22
+ Navigate to the project folder and install needed dependencies:
23
+
24
+ ```
25
+ $ npm install
26
+ $ bower install
27
+ ```
28
+
29
+ ## Building
30
+
31
+ This module comes with a few gulp tasks wich help you automate the development process. The following tasks are provided:
32
+
33
+ ###### gulp help
34
+
35
+ Will show you the list of available tasks.
36
+
37
+ ###### gulp clean
38
+
39
+ Will delete ` release ` folder where the module and his minified version are copied.
40
+
41
+ ###### gulp build-min
42
+
43
+ Will updates the minified version of the module (` angular-link-header-parser.min.js ` ).
44
+
45
+ ###### gulp copy-module
46
+
47
+ Will updates the module (` angular-link-header-parser.js ` ).
48
+
49
+ ###### gulp build
50
+
51
+ Simple task wich trigger ` build-min ` and ` copy-module ` tasks.
52
+
53
+ ## Submitting fixes and/or improvements
54
+
55
+ I'm using the ` git-flow ` process so I have only 2 branches ` master ` and ` develop ` . ` develop ` is used to the development process.
56
+
57
+ * Checkout a new branch based on ` develop ` and name it to what you intend to do
58
+ * Example: `$ git checkout -b BRANCH_NAME`
59
+ * Make your changes
60
+ * Commit your changes
61
+ * Please provide a git message which explains what you've done
62
+ * Merge your changes to ` develop `
63
+ * Make a pull request
64
+
You can’t perform that action at this time.
0 commit comments