ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add more content everywhere

Browse Source
This commit is contained in:
Hans Pagel
2020-09-15 21:07:16 +02:00
parent 3470400785
commit 17c22b8a2b
8 changed files with 46 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/src/docPages/overview/contributing.md
View File

@@ -1,11 +1,20 @@
# Contributing
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 contributions:
## What kind of contributions are welcome
## What kind of contributions won’t be merged
## How to send your first Pull Request
* Improved documentation, e. g. fixing typos, new sections, further explanation …)
* New features for existing extensions, e. g. a new option
* New extensions, which don’t require changes to the core or other core extensions
* Well explained, non-breaking changes to the core
## Code style
## Testing
There is a 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. Make sure it’s 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. We’ll get back to you.