Skip to content

Commit 4933fb2

Browse files
author
Dipu Raj
committed
Readme update
1 parent c063a97 commit 4933fb2

File tree

2 files changed

+25
-14
lines changed

2 files changed

+25
-14
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@
44
- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/).
55
- Add new features to the project.
66
- Add new test cases.
7-
- Add documentation
8-
- Add a demo page
9-
- [Donate](https://www.paypal.me/dipuraj) money for the project on [Paypal](https://www.paypal.me/dipuraj)
7+
- Add documentation.
8+
- Add a demo page.
9+
- [Donate](https://www.paypal.me/dipuraj) money for the project on [![Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj).
1010

11-
## How to contribute code
12-
Here are the basic steps to get started contributing:
11+
## How to contribute code?
12+
Here are the basic steps to get started contributing code:
1313

1414
1. Fork the [repo](https://github.com/techlab/SmartWizard/) and get development running on your computer.
15-
2. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
16-
3. Change the code to fix the bug or add the feature. All changes should happen in the relevant `src/js/*.js` and `src/css/*.css` files.
17-
4. Build the code by running `npm run build` or `gulp build`
18-
5. Run the test cases by running `npm test` or `gulp test`, you can also add more test cases based on your new change.
19-
6. Verify that your fix or feature works.
20-
7. Commit your changes with an informative description
21-
8. Open a pull request to the [repo](https://github.com/techlab/SmartWizard/) with your new commit and a descriptive message about what the PR does.
15+
2. Install the npm development dependencies by the command `npm install` on the project folder (Assumes you already have NodeJS installed).
16+
3. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
17+
4. Change the code to fix the bug or add the feature. All changes should happen in the relevant `src/js/*.js` and `src/css/*.css` files.
18+
5. Build the code by running `npm run build` or `gulp build`.
19+
6. Run the test cases by running `npm test` or `gulp test`, you can also add more test cases based on your new change.
20+
7. Verify that your fix or feature works.
21+
8. Commit your changes with an informative description.
22+
9. Open a pull request to the [repo](https://github.com/techlab/SmartWizard/) with your new commit and a descriptive message about what the PR does.
2223

2324
## Reporting bugs
2425
### Make sure it is a bug related to this project
@@ -33,4 +34,5 @@ If not, create a new issue there and include your test case.
3334
### Notes for pull request
3435
- Follow the same code style as the library.
3536
- Run the test suites in the `test` directory first by running `npm test` or `gulp test`.
36-
- Don't modify any files in the `dist` directory.
37+
- Don't modify any files in the `dist` directory.
38+
- Don't alter the licence headers.

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[![Bower version](https://badge.fury.io/bo/smartwizard.svg)](https://badge.fury.io/bo/smartwizard)
77
[![Latest Stable Version](https://poser.pugx.org/techlab/smartwizard/v/stable)](https://packagist.org/packages/techlab/smartwizard)
88
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/techlab/SmartWizard/master/LICENSE)
9-
[![Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj)
9+
[![JSPlanet Plugin Info](https://img.shields.io/badge/-smartwizard-brightgreen.svg?logoWidth=33&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAACEAAAAOCAYAAAChHnWMAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAsNJREFUeNqElctr1FAUxu9N0mHSdqYdFUXFhbpRXMmIm1ofFXEhKgiiiC9QEcRNQf8AQdyIGxFBilDfIhSri4q6kSq6UKRdFPFZrQ9caLXYqTYzk%2Bt3ki94GSd64BdukpPku%2Bd%2B90RXeleqOrEIHAZTwTNwCozw3gKwF7SBaUCDcfDSDdXRT5lwsLsQ5JtCvQfXVoDvIAvywAEGjIFboEee9VT9mAm2gQYwG1zg9aXgMpjP818gYM5c0AcG8RUftEPdRuaViaIgEbOF7zuUJqLKh0TEBCjxeqcl4DU4DV6AKWAJavKjgi9PahVmtao2mGjaX3CvGzwF8r1VYDNoBvtlUmkifAqQ%2BEkhmhVK4gi4BEKen5eDa%2BJp6rjsEp%2FBFYpQrOp0sE7SwUInRYTHkikKCLiW762cNfREFJIc4DCSMQp%2BcDyjPKow6o%2BgJAJrPJEmwrVEyLpXOD4DhjneAU6AeXKipe4ow%2FV8WWVjAT7zKix9jt45AJbznpj2SZqIHMufVGKS4wf0xVuebwddYLFkF%2BCk9pIrnnBYTYmvYBk4B3rBce468d0x8Mb5hydUnUpI3AC7wGOWuQOchTHa%2FKqjiiVPBdqIn5osT5UioWLeeHwPHAQn5d31jKm5p%2B31q9bk9FOIvGS1fMBEvcRsUo4ZpqkbrS15h8%2FMYGWlkh8TUzspfmhOMZEd0sT2gYdWE9vJsS1CqjgKBsBtcJ8GD21T65qXzwJ2G016RGvNMinO6DnHGTDHEuHXVDc1ZDkugg9gCLSA9ZZ7xZCvOJbruznzAd4rgg2Wd4aMNCgdvTdbp1umipDWuZUGcq2HFd3cx3FIc3XwXxEyVypgsDvvfvNM17VCWfmhbuEOSyYS%2FE%2BEbLG1NE0jVb%2Fjz%2BUqfzYSj9gnilwyn7myJDelomjZ42OOUblQj6L%2BPSY2eH%2FN7vorfgswAHj%2Bx0e8DTcuAAAAAElFTkSuQmCC%0A)](http://jsplanet.net/plugin/1000/jquery/jquery-smart-wizard)
10+
[![Donate on Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj)
1011

1112
Smart Wizard is a flexible and heavily customizable **jQuery step wizard plugin** with **Bootstrap** support. It is easy to implement and gives a neat and stylish interface for your forms, checkout screen, registration steps etc. Based on the feedback from our users over the past years we have come up with the **best ever built jQuery wizard plugin of all time**, All new Smart Wizard 4. The plugin is been completely rewritten from scratch, made it more powerful, robust, scalable and customizable. We have added a lot of features not limited to Bootstrap support, themes, customizable toolbars, customizable options, public methods, event support and a lot more. See the list of [features](http://techlaboratory.net/smartwizard#features), [demos](http://techlaboratory.net/smartwizard/demo) and [documentation](http://techlaboratory.net/smartwizard/documentation) for more details.
1213

@@ -75,3 +76,11 @@ Features
7576
License
7677
----
7778
[MIT License](https://github.com/techlab/SmartWizard/blob/master/LICENSE)
79+
80+
Contribute
81+
----
82+
If you like the project please support with your contribution.
83+
84+
[Donate on Paypal](https://www.paypal.me/dipuraj)
85+
86+
Thank you :)

0 commit comments

Comments
 (0)