Skip to content

Commit 794cfa3

Browse files
committed
docs: add notes on new feature. close sayanee#86
1 parent 92667b3 commit 794cfa3

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
1-
#Contribute and share
1+
# Contributing to angular-pdf
22

3-
1. Fork this project and install the packages with npm and bower
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
44

5-
```
6-
bower i && npm i
7-
```
8-
- Create a new feature/patch branch
5+
## for fixes
6+
7+
1. This is for a fix or a patch for a found bug
8+
- Fork this project and install the packages with npm and bower
9+
10+
```
11+
bower i && npm i
12+
```
13+
- Create a new patch branch
914
- Code code code and amend the file `dist/angular-pdf.js`
1015
- Run `npm run build` to create the build minified and example files
1116
- Code code code
1217
- Run `npm test` to ensure the [build](https://travis-ci.org/sayanee/angularjs-pdf) and the tests will pass
1318
- Write a [good commit message](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format)
14-
- [Pull request](https://help.github.com/articles/using-pull-requests) using the new feature/patch branch
19+
- [Pull request](https://help.github.com/articles/using-pull-requests) using the new patch branch
1520
- Ensure the [Travis build and tests](https://travis-ci.org/sayanee/angularjs-pdf) passes
1621

22+
## for new features
23+
24+
1. Search :mag_right: if the [feature already exists](https://github.com/sayanee/angularjs-pdf/blob/master/readme.md) or was discussed previously in [closed issues](https://github.com/sayanee/angularjs-pdf/issues?q=is%3Aissue+is%3Aclosed)
25+
- Raise an issue to discuss :speech_balloon: , ask for feedback or help :thought_balloon:
26+
- Ensure the pull request is accompanied by new feature code and specs / tests ( similar to [submitting fixes](https://github.com/sayanee/angularjs-pdf/blob/master/CONTRIBUTING.md#for-fixes) )
27+
1728
##Make a Release (for maintainers only)
1829

1930
1. commit your code (steps 1 - 7)

0 commit comments

Comments
 (0)