From 8c53d04fca7b6706eab9974af70270e0d89665c2 Mon Sep 17 00:00:00 2001 From: Ray Nicholus Date: Fri, 13 May 2016 16:07:33 -0500 Subject: [PATCH] docs(README): add contributing section #1568 --- README.md | 17 +++++++++ docs/contributing.jmd | 85 ------------------------------------------- package.json | 3 ++ 3 files changed, 20 insertions(+), 85 deletions(-) delete mode 100644 docs/contributing.jmd diff --git a/README.md b/README.md index bfe4f0bb7..68174a483 100644 --- a/README.md +++ b/README.md @@ -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/ \ No newline at end of file diff --git a/docs/contributing.jmd b/docs/contributing.jmd deleted file mode 100644 index 420c5912c..000000000 --- a/docs/contributing.jmd +++ /dev/null @@ -1,85 +0,0 @@ -{% extends "_templates/base.html" %} -{% set page_title = "Contributing" %} -{% block content %} -{% markdown %} -# Building From Source & Contributing - -## Build status - - - - - - - - - - - - - - - - - - -
BranchTravis
Master
Develop
- -## Building - -You can build your own version-stamped copy of Fine Uploader's combined source code using the build file -located in the root of the repository. In either case, you can download a development or stable copy on the -website as well. - -{{ alert( -"""If you are developing a commercial project or are using Fine Uploader for commercial purposes, you must [purchase a Widen Commercial License](http://fineuploader.com/purchase) -before using Fine Uploader in your product.""" -)}} - -The following instructions are aimed at unix/linux operating systems, such as OSX, Ubuntu, BSD, etc. If you are using Windows, -you'll need to make the appropriate adjustments to the following steps. - -To build Fine Uploader, you must: - -1. Install [git][git]. -2. Install [node.js][node]. -3. Install [grunt][grunt]: `sudo npm install -g grunt-cli`. -4. Clone the repository: `git clone git://github.com/Widen/fine-uploader`. -5. Change to the new fine-uploader directory: `cd fine-uploader`. -6. Ensure all Fine Uploader build dependencies are installed: `npm install`. -7. Build Fine Uploader: `grunt package`. - -The last step will generate various .zip files that correspond to all of the high-level types of Fine Uploader, -such as Fine Uploader S3, Fine Uploader UI, etc. These zip files will be located in the `./_dist/` directory. - -If you'd like to start up Fine Uploader's internal development PHP server (for manual testing during development): -1. Follow all build steps above. -2. Run `npm run setup-dev`. -3. Run `npm run start-local-dev`. If you are developing on Cloud9IDE, run `npm run start-c9-dev` instead. -4. Ensure you have a `test/dev/handlers/s3/s3keys.sh` file with the following global variables defined with the appropriate values: `$clientPrivateKey`, `$serverPrivateKey`, and `$serverPublicKey`. -5. Navigate to `http://localhost:9090/test/dev/` for the manual test development page. - - -## Contributing Changes - -To contribute to development [fork it](https://github.com/Widen/fine-uploader/fork), and make sure to submit any pull requests against the "develop" branch. See [How do I contribute to other's code in GitHub?](http://stackoverflow.com/questions/4384776/how-do-i-contribute-to-others-code-in-github). - -Pull requests **MUST** be against the "develop" branch! - -1. Follow all steps in the Building section above, up until (and including) step 5. -2. Checkout the "develop" branch. It's where in-progress versions are staged: `git checkout develop`. -3. Ensure all Fine Uploader build dependencies are installed: `npm install`. -4. From the develop branch, create a branch based off of develop that describes your proposed changes, -such as `git checkout -b feature/more-efficient-scaling`. -5. Run `grunt dev`. This will prepare the development environment. -6. `grunt build` will build the latest version from the source code into `./_build/`. -7. Before you open up a pull request, be sure to run all unit tests: `grunt test:firefox`. - - -[git]: http://git-scm.com/downloads -[node]: http://nodejs.org/ -[grunt]: http://gruntjs.com/ -[licensefaq]: http://fineuploader.com/faq - -{% endmarkdown %} -{% endblock %} diff --git a/package.json b/package.json index 91c55ea00..645fa6d13 100644 --- a/package.json +++ b/package.json @@ -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" } }