- Welcome examples
- Submit ideas
- Set up the development environment
- Our code style
- Testing for errors
- Futher questions
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:
- Failing regression tests as bug reports
- Documentation improvements, e. g. fix a typo, add a section
- New features for existing extensions, e. g. a new configureable option
- New extensions, which don’t require changes to the core or other core extensions
- Well explained, non-breaking changes to the core
Make sure to open an issue and outline your idea first. We’ll get back to you quickly and let you know if there is a chance we can merge your contribution.
Set up the development environment
- Copy the code to your local machine:
$ git clone firstname.lastname@example.org:ueberdosis/tiptap.git
- Install dependencies:
$ yarn install
- Start the development environment:
$ yarn start
- Open http://localhost:3000 in your favorite browser.
- Start playing around!
Our code style
There is an eslint config that ensures a consistent code style. To check for errors, run
$ yarn run lint. That’ll be checked when you send a pull request, too. Make sure it’s passing, before sending a pull request.
Testing for errors
Your pull request will automatically execute all our existing tests. Make sure that they all pass, before sending a pull request. 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. We’ll get back to you.