2.43 kBMarkdownView Raw
1# Contributing
3## How can I contribute?
4- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/jquery-smartwizard/issues/).
5- Add new features to the project.
6- Create new themes
7- Add new test cases.
8- Add documentation.
9- Add a demo page.
10- [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)
12## How to contribute code?
13Here are the basic steps to get started contributing code:
151. Fork the [repo](https://github.com/techlab/jquery-smartwizard/).
162. Install the dependencies, run `npm install`.
173. Start the project, run `npm start`.
184. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
195. Modify the code to fix the bug or to add the feature. All changes should happen in the relevant `src/js/*.js` and `src/scss/*.scss` files.
206. Verify that your fix or feature works.
217. Run the test cases by running `npm test`, you can also add more test cases based on your new change.
228. Build the code by running `npm run build`.
239. Commit your changes with an informative description.
2410. Open a pull request to the [dev](https://github.com/techlab/jquery-smartwizard/tree/dev) branch of the [repo](https://github.com/techlab/jquery-smartwizard/) with your new commit and a descriptive message about what the PR does.
26Thank you for your contribution!
28##### Notes for pull request
29- Follow the same code style as the library.
30- Run the test suites in the `test` directory first by running `npm test`.
31- Don't modify any files in the `dist` directory.
32- Don't alter the licence headers.
34## Reporting bugs
35#### Make sure it is a bug related to this project
36Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.
38#### Try the latest version
39Bugs in the older versions of the project may have already been fixed.
40In order to avoid reporting known issues, make sure you are always testing against the latest release.
41Also make sure the problem hasn't already been reported on the [GitHub Issues Tracker](https://github.com/techlab/jquery-smartwizard/issues/).
42If not, create a new issue there and include your test case.
44## Contributors
45Million thanks to all our [Code Contributors](https://github.com/techlab/jquery-smartwizard/graphs/contributors) and Supporters.