From 69221eb7eb230c59c3057df2577fec5fa6341777 Mon Sep 17 00:00:00 2001 From: vitalets Date: Sun, 24 Dec 2017 14:47:56 +0300 Subject: [PATCH] add contributing.md and move details there --- CONTRIBUTING.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 69 ++----------------------------------------------- 2 files changed, 67 insertions(+), 67 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c1eb274c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +## How to contribute +A few steps how to start contributing. +Assuming you have [Node.js](http://nodejs.org/) already installed. + +1.Fork *X-editable* on github and clone it to your local machine: +```` +git clone https://github.com//x-editable.git +```` +2.Install *grunt-cli* globally (if not yet): +```` +npm i -g grunt-cli +```` +3.Install dependencies: +```` +cd x-editable +npm i +```` +4.Make your changes: +```` +vim editable-form.js +```` +5.Write some tests for your changes: +```` +vim /test/unit/*.js +```` +6.Run tests in cli: +```` +grunt test +```` +or directly in browser: +```` +grunt server +```` +and open http://127.0.0.1:8000/test +By default test run on bootstrap 3 popup version, but you can test any other build: + +* bootstrap 3 + * popup: http://127.0.0.1:8000/test/?f=bootstrap3&c=popup + * inline: http://127.0.0.1:8000/test/?f=bootstrap3&c=inline +* bootstrap 2 + * popup: http://127.0.0.1:8000/test/?f=bootstrap2&c=popup + * inline: http://127.0.0.1:8000/test/?f=bootstrap2&c=inline +* jquery-ui + * popup: http://127.0.0.1:8000/test/?f=jqueryui&c=popup + * inline: http://127.0.0.1:8000/test/?f=jqueryui&c=inline +* jquery + poshytip + * popup: http://127.0.0.1:8000/test/?f=plain&c=popup + * inline: http://127.0.0.1:8000/test/?f=plain&c=inline + +7.Commit and push back on github: +```` +git add . +git commit -m'refactor editable form, fix #123' +git push origin +```` +8.Make pull request on github (to `develop` branch). + +Thanks for your support! + +### Local build +To build x-editable locally please run: +```` +grunt build +```` +Result will appear in `dist` directory. diff --git a/README.md b/README.md index 1b7bef4b..d2be4b91 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery. **http://vitalets.github.io/x-editable/demo.html** ## Pull Requests -Please submit all Pull Requests to the `develop` branch: https://github.com/vitalets/x-editable/tree/develop +Please submit all Pull Requests to the `develop` branch: https://github.com/vitalets/x-editable/tree/develop +More details are in [CONTRIBUTING.md](/CONTRIBUTING.md). ## Issue Tracker Please report all issues here: https://github.com/vitalets/x-editable/issues @@ -64,72 +65,6 @@ It's really saves much time. Use these as template: 4. [jsFiddle jQuery](http://jsfiddle.net/xBB5x/197) Your feedback is very appreciated! -## Contribution -A few steps how to start contributing. -Assuming you have [Node.js](http://nodejs.org/) already installed. - -1.Fork *X-editable* on github and clone it to your local mashine: -```` -git clone https://github.com//x-editable.git -b dev -```` -2.Install *grunt-cli* globally (if not yet): -```` -npm i -g grunt-cli -```` -3.Install dependencies: -```` -cd x-editable -npm i -```` -4.Make your changes: -```` -vim editable-form.js -```` -5.Write some tests for your changes: -```` -vim /test/unit/*.js -```` -6.Run tests in cli: -```` -grunt test -```` -or directly in browser: -```` -grunt server -```` -and open http://127.0.0.1:8000/test -By default test run on bootstrap 3 popup version, but you can test any other build: - -* bootstrap 3 - * popup: http://127.0.0.1:8000/test/?f=bootstrap3&c=popup - * inline: http://127.0.0.1:8000/test/?f=bootstrap3&c=inline -* bootstrap 2 - * popup: http://127.0.0.1:8000/test/?f=bootstrap2&c=popup - * inline: http://127.0.0.1:8000/test/?f=bootstrap2&c=inline -* jquery-ui - * popup: http://127.0.0.1:8000/test/?f=jqueryui&c=popup - * inline: http://127.0.0.1:8000/test/?f=jqueryui&c=inline -* jquery + poshytip - * popup: http://127.0.0.1:8000/test/?f=plain&c=popup - * inline: http://127.0.0.1:8000/test/?f=plain&c=inline - -7.Commit and push back on github: -```` -git add . -git commit -m'refactor editable form, fix #123' -git push origin -```` -8.Make pull request on github (to `dev` branch). - -Thanks for your support! - -### Local build -To build x-editable locally please run: -```` -grunt build -```` -Result will appear in `dist` directory. - ## License Copyright (c) 2012 Vitaliy Potapov Licensed under the MIT license.