tiptap/docs/overview/contributing.md

---
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](https://github.com/git-guides/install-git), [Node and NPM](https://nodejs.org/en/download/) installed. Here is what you need to do then:

1. Copy the code to your local machine: `$ git clone git@github.com: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

```bash
npm init tiptap-extension
```

If you want to let us know about your extension you can give us a hint on [Twitter](https://twitter.com/tiptap_editor) or [Discord](https://discord.gg/WtJ49jGshW).

## Further questions
Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.
-												docs: use front matter to enable table of contents

											
										
										
											2021-08-24 17:24:10 +08:00
+								---
 								tableOfContents: true
 								---
-												add contributing and sponsoring to the sitemap

											
										
										
											2020-09-09 22:15:36 +08:00
+								# Contributing
-												add more content

											
										
										
											2020-09-30 22:16:15 +08:00
+								## Introduction
-												docs: fix typos

											
										
										
											2022-11-08 04:41:00 +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:
-												add more content

											
										
										
											2020-09-30 22:16:15 +08:00
 								## Welcome examples
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								* 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
-												add more content everywhere

											
										
										
											2020-09-16 03:07:16 +08:00
+								* Well explained, non-breaking changes to the core
-												add contributing and sponsoring to the sitemap

											
										
										
											2020-09-09 22:15:36 +08:00
-												Update contributing.md
											
										
										
											2021-11-24 20:51:20 +08:00
+								## Won’t merge
 								* New extensions, which we then need to support and maintain
-												docs: update content

											
										
										
											2020-12-10 22:56:18 +08:00
+								## 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.
-												add redirects (easypeasy)

											
										
										
											2020-11-12 22:31:44 +08:00
+								## Set up the development environment
-												refactor(global): remove yarn in favor for npm

re #2087

											
										
										
											2022-05-10 21:30:14 +08:00
+								It’s not too hard to tinker around with the official repository. You’ll need [Git](https://github.com/git-guides/install-git), [Node and NPM](https://nodejs.org/en/download/) installed. Here is what you need to do then:
-												add redirects (easypeasy)

											
										
										
											2020-11-12 22:31:44 +08:00
-												replace GitHub remote URL

											
										
										
											2021-04-21 21:31:32 +08:00
+. Copy the code to your local machine: `$ git clone git@github.com:ueberdosis/tiptap.git`
-												refactor(global): remove yarn in favor for npm

re #2087

											
										
										
											2022-05-10 21:30:14 +08:00
+. Install dependencies: `$ npm install`
 . Start the development environment: `$ npm run start`
-												add redirects (easypeasy)

											
										
										
											2020-11-12 22:31:44 +08:00
+. Open http://localhost:3000 in your favorite browser.
 . Start playing around!
-												add more content

											
										
										
											2020-09-30 22:16:15 +08:00
+								## Our code style
-												refactor(global): remove yarn in favor for npm

re #2087

											
										
										
											2022-05-10 21:30:14 +08:00
+								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.
-												add more content everywhere

											
										
										
											2020-09-16 03:07:16 +08:00
-												add more content

											
										
										
											2020-09-30 22:16:15 +08:00
+								## Testing for errors
-												refactor(global): remove yarn in favor for npm

re #2087

											
										
										
											2022-05-10 21:30:14 +08:00
+								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`.
-												add more content everywhere

											
										
										
											2020-09-16 03:07:16 +08:00
-												docs: add extension cli note to contributing docs (#3793)

* docs: add extension cli note to contributing docs

* docs: add notes to CLI

* docs: fix rollup and vite naming
											
										
										
											2023-02-28 04:22:34 +08:00
+								## 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
 								```bash
 								npm init tiptap-extension
 								```
 								If you want to let us know about your extension you can give us a hint on [Twitter](https://twitter.com/tiptap_editor) or [Discord](https://discord.gg/WtJ49jGshW).
-												docs: Fix typo in contributing.md (#2352)


											
										
										
											2022-01-05 06:21:02 +08:00
+								## Further questions
-												add more content everywhere

											
										
										
											2020-09-16 03:07:16 +08:00
+								Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.