You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-11Lines changed: 10 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -12,23 +12,22 @@
12
12
## How to contribute code?
13
13
Here are the basic steps to get started contributing code:
14
14
15
-
1. Fork the [repo](https://github.com/techlab/jquery-smartwizard/) and get development running on your computer.
16
-
2. Install gulp and karma`npm install gulp-cli karma-cli -g`
17
-
3.Install the npm development dependencies by the command `npm install` on the project folder (Should have NodeJS installed).
15
+
1. Fork the [repo](https://github.com/techlab/jquery-smartwizard/).
16
+
2. Install the dependencies, run`npm install`.
17
+
3.Start the project, run `npm start`.
18
18
4. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
19
-
5. Run `gulp watch` before start changing code. It will auto build and bundle the `.js` and `.css` files when you change.
20
-
6. 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.
21
-
7. Build the code by running `npm run build` or `gulp build`.
22
-
8. Run the test cases by running `npm test` or `gulp test`, you can also add more test cases based on your new change.
23
-
9. Verify that your fix or feature works.
24
-
10. Commit your changes with an informative description.
25
-
11. 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.
19
+
5. 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.
20
+
6. Verify that your fix or feature works.
21
+
7. Run the test cases by running `npm test`, you can also add more test cases based on your new change.
22
+
8. Build the code by running `npm run build`.
23
+
9. Commit your changes with an informative description.
24
+
10. 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.
26
25
27
26
Thank you for your contribution!
28
27
29
28
##### Notes for pull request
30
29
- Follow the same code style as the library.
31
-
- Run the test suites in the `test` directory first by running `npm test` or `gulp test`.
30
+
- Run the test suites in the `test` directory first by running `npm test`.
0 commit comments