Skip to content
This repository has been archived by the owner on Nov 20, 2018. It is now read-only.

Commit

Permalink
docs(README): add contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
rnicholus committed May 13, 2016
1 parent 5565d03 commit 8c53d04
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 85 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,21 @@ FineUploader is also simple to use. In the simplest case, you only need to inclu
There are absolutely no other required external dependencies. For more information, please see the [**documentation**](http://docs.fineuploader.com).


## Contributing

Fine Uploader and all other projects in this organization thrive thanks to donations by Widen (the project's sponsor)
and support by developers in the community. If you'd like to help, the best way to do so is open up a pull request
that addresses one of the open feature requests or bugs. In order to get started developing Fine Uploader, follow these
steps to get the project up and running on your local development machine:

1. Download the project repository: `git clone https://github.com/FineUploader/fine-uploader.git`.
2. Install all project development dependencies: `npm install`.
3. To run the tests & linter: `$(npm bin)/grunt dev test:firefox` (you'll need Firefox installed locally).
4. Please follow the [Angular.js commit guidelines][angular-commit].
5. Please follow the [Git Flow][git-flow] branching strategy.


*Fine Uploader is a code library sponsored by [Widen Enterprises, Inc.](http://www.widen.com/)*

[angular-commit]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
[git-flow]: http://nvie.com/posts/a-successful-git-branching-model/
85 changes: 0 additions & 85 deletions docs/contributing.jmd

This file was deleted.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,8 @@
"start-local-dev": "(. test/dev/handlers/s3keys.sh; php -S 0.0.0.0:9090 -t . -c test/dev/handlers/php.ini)",
"start-c9-dev": "php -S $IP:$PORT -t . -c test/dev/handlers/php.ini",
"update-dev": "(cd test/dev/handlers; php composer.phar update)"
},
"engines" : {
"node" : "0.10.33"
}
}

0 comments on commit 8c53d04

Please sign in to comment.