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
|
8 | for something that looks interesting to you to pick up. Some issues are marked
|
9 | ["help wanted"](https://github.com/josdejong/mathjs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22),
|
10 | these are typically issues which should be relatively easy to pick up.
|
11 |
|
12 | ### There are a few preferences regarding code contributions:
|
13 |
|
14 | - 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.
|
15 | - Make sure you properly unit test your changes.
|
16 | - Before creating a pull request, run the unit tests to make sure they all pass.
|
17 | - Only commit changes done in the source files under `src`, not to the generated builds
|
18 | which are located in the folders `dist` and `lib`.
|
19 | - Send pull requests to the `develop` branch, not the `master` branch.
|
20 |
|
21 | ### FAQ
|
22 |
|
23 | - How to implement a new function? Answer: See the section [Implementing a new function](README.md#implementing-a-new-function) in the README.md.
|
24 | - Where to find more documentation? Answer: best starting point is the project's [README.md](https://github.com/josdejong/mathjs#readme) file.
|
25 | - 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.
|
26 |
|
27 | Thanks!
|