| 1 | ## Contributing
|
| 2 |
|
| 3 | Contributions to the math.js library are very welcome! We can't do this alone. You can contribute in different ways: spread the word, report bugs, come up with ideas and suggestions, and contribute to the code.
|
| 4 |
|
| 5 | ### What can I do?
|
| 6 |
|
| 7 | Search through the [issues](https://github.com/josdejong/mathjs/issues) looking for bugs that you can help fix, or look at [discussions/ideas](https://github.com/josdejong/mathjs/discussions/categories/ideas) to see if there is an idea for a new feature that that looks interesting to pick up.
|
| 8 |
|
| 9 | ### There are a few preferences regarding code contributions:
|
| 10 |
|
| 11 | - The code of math.js follows the JavaScript Standard Style as described on https://standardjs.com/, powered by `eslint`. Run `npm run lint` to test, and `npm run format` to automatically adjust your code to the code style.
|
| 12 | - Make sure you properly unit test your changes.
|
| 13 | - Before creating a pull request, run the unit tests to make sure they all pass.
|
| 14 | - Only commit changes done in the source files under `src`, not to the generated builds
|
| 15 | which are located in the folders `dist` and `lib`.
|
| 16 | - Send pull requests to the `develop` branch, not the `master` branch.
|
| 17 |
|
| 18 | ### FAQ
|
| 19 |
|
| 20 | - How to implement a new function? Answer: See the section [Implementing a new function](README.md#implementing-a-new-function) in the README.md.
|
| 21 | - Where to find more documentation? Answer: best starting point is the project's [README.md](https://github.com/josdejong/mathjs#readme) file.
|
| 22 | - I'm not sure how/where to start, what now? Answer: feel free to ask when in doubt, just [open an issue](https://github.com/josdejong/mathjs/issues) and discuss your thoughts and questions.
|
| 23 |
|
| 24 | Thanks!
|