1 | # Contributing
|
2 |
|
3 | ## How can I contribute?
|
4 | - Fix a bug you found or already reported.
|
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 |
|
11 | ## How to contribute code?
|
12 | Here are the basic steps to get started contributing code:
|
13 |
|
14 | 1. Fork the repository.
|
15 | 2. Install the dependencies, run `npm install`.
|
16 | 3. Start the project, run `npm start`.
|
17 | 4. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
|
18 | 5. Modify the code to fix the bug or to add the feature. All changes should happen in the relevant `src/` files.
|
19 | 6. Verify that your fix or feature works.
|
20 | 7. Run the test cases by running `npm test`, you can also add more test cases based on your new change.
|
21 | 8. Build the code by running `npm run build`.
|
22 | 9. Commit your changes with an informative description.
|
23 | 10. Open a pull request with a descriptive message about what the PR does.
|
24 |
|
25 | Thank you for your contribution!
|
26 |
|
27 | ##### Notes for pull request
|
28 | - Follow the same code style as the library.
|
29 | - Run the test suites in the `test` directory first by running `npm test`.
|
30 | - Don't modify any files in the `dist` directory.
|
31 | - Don't alter the licence headers.
|
32 |
|
33 | ## Reporting bugs
|
34 | #### Make sure it is a bug related to this project
|
35 | Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.
|
36 |
|
37 | #### Try the latest version
|
38 | Bugs in the older versions of the project may have already been fixed.
|
39 | In order to avoid reporting known issues, make sure you are always testing against the latest release.
|
40 | Also make sure the problem hasn't already been reported on the GitHub Issues Tracker.
|
41 | If not, create a new issue there and include your test case.
|