mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
66ce56bfcb
* Fix #2528: improve explanation in CONTRIBUTING.md * Move explanation on implementing a new function to the README, and add a small FAQ section to CONTRIBUTING.md to keep it short
28 lines
1.7 KiB
Markdown
28 lines
1.7 KiB
Markdown
## Contributing
|
|
|
|
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.
|
|
|
|
### What can I do?
|
|
|
|
Search through the [issues](https://github.com/josdejong/mathjs/issues) looking
|
|
for something that looks interesting to you to pick up. Some issues are marked
|
|
["help wanted"](https://github.com/josdejong/mathjs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22),
|
|
these are typically issues which should be relatively easy to pick up.
|
|
|
|
### There are a few preferences regarding code contributions:
|
|
|
|
- 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.
|
|
- Make sure you properly unit test your changes.
|
|
- Before creating a pull request, run the unit tests to make sure they all pass.
|
|
- Only commit changes done in the source files under `src`, not to the generated builds
|
|
which are located in the folders `dist` and `lib`.
|
|
- Send pull requests to the `develop` branch, not the `master` branch.
|
|
|
|
### FAQ
|
|
|
|
- How to implement a new function? Answer: See the section [Implementing a new function](README.md#implementing-a-new-function) in the README.md.
|
|
- Where to find more documentation? Answer: best starting point is the project's [README.md](https://github.com/josdejong/mathjs#readme) file.
|
|
- 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.
|
|
|
|
Thanks!
|