tiptap/docs/overview/contributing.md

39 lines
1.9 KiB
Markdown
Raw Normal View History

---
tableOfContents: true
---
# Contributing
2020-09-30 22:16:15 +08:00
## Introduction
2020-10-30 23:13:47 +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-30 22:16:15 +08:00
## Welcome examples
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
2020-09-16 03:07:16 +08:00
* Well explained, non-breaking changes to the core
2021-11-24 20:51:20 +08:00
## Wont merge
* New extensions, which we then need to support and maintain
2020-12-10 22:56:18 +08:00
## Submit ideas
Make sure to open an issue and outline your idea first. Well get back to you quickly and let you know if there is a chance we can merge your contribution.
2020-11-12 22:31:44 +08:00
## Set up the development environment
2021-05-19 00:36:18 +08:00
Its not too hard to tinker around with the official repository. Youll need [Git](https://github.com/git-guides/install-git), [Node](https://nodejs.org/en/download/) and [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) installed. Here is what you need to do then:
2020-11-12 22:31:44 +08:00
2021-04-21 21:31:32 +08:00
1. Copy the code to your local machine: `$ git clone git@github.com:ueberdosis/tiptap.git`
2020-11-12 22:31:44 +08:00
2. Install dependencies: `$ yarn install`
3. Start the development environment: `$ yarn start`
4. Open http://localhost:3000 in your favorite browser.
5. Start playing around!
2020-09-30 22:16:15 +08:00
## Our code style
There is an 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, too. Make sure its passing, before sending a pull request.
2020-09-16 03:07:16 +08:00
2020-09-30 22:16:15 +08:00
## 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`.
2020-09-16 03:07:16 +08:00
2020-11-12 22:31:44 +08:00
## Futher questions
2020-09-16 03:07:16 +08:00
Any further questions? Create a new issue or discussion in the repository. Well get back to you.