tiptap/docs/src/docPages/overview/contributing.md

19 lines
1.1 KiB
Markdown
Raw Normal View History

# Contributing
2020-09-22 21:45:57 +08:00
Tiptap would be nothing without its lively community. Contributions have always been and will always be welcome. Here is a little bit you should know, before you send your contribution:
2020-09-27 16:29:01 +08:00
## Table of Contents
2020-09-27 16:29:01 +08:00
## Examples
2020-09-16 03:07:16 +08:00
* Improved documentation, e. g. fixing typos, new sections, further explanation …)
* New features for existing extensions, e. g. a new option
* New extensions, which dont require changes to the core or other core extensions
* Well explained, non-breaking changes to the core
## Code style
2020-09-16 03:07:16 +08:00
There is a eslint config, that ensures a consistent code style. To check for errors, run `$ yarn run lint`. Thatll be checked when you send a pull request. Make sure its passing, before sending a pull request.
## Testing
All your pull requests will automatically run all our existing tests. Make sure that they all pass. Run all tests locally with `$ yarn run test` or run single tests (e. g. when writing new ones) with `$ yarn run test:open`.
Any further questions? Create a new issue or discussion in the repository. Well get back to you.