Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.33 KB

contributing.md

File metadata and controls

47 lines (34 loc) · 2.33 KB
Raw
tableOfContents
true

Contributing

Introduction

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:

Welcome examples

  • 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
  • Well explained, non-breaking changes to the core

Won’t merge

  • New extensions, which we then need to support and maintain

Submit ideas

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

It’s not too hard to tinker around with the official repository. You’ll need Git, Node and NPM installed. Here is what you need to do then:

  1. Copy the code to your local machine: $ git clone [email protected]:ueberdosis/tiptap.git
  2. Install dependencies: $ npm install
  3. Start the development environment: $ npm run start
  4. Open http://localhost:3000 in your favorite browser.
  5. Start playing around!

Our code style

There is an eslint config that ensures a consistent code style. To check for errors, run $ npm 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 $ npm run test or run single tests (e. g. when writing new ones) with $ npm run test:open.

Creating your own extensions

If you want to create and maintain your own extensions, you can use your create-tiptap-extension CLI tool. It will create a new extension boilerplate with all necessary files and the build process. It's as easy as running

npm init tiptap-extension

If you want to let us know about your extension you can give us a hint on Twitter or Discord.

Further questions

Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.