Contributing

• Introduction
• Welcome examples
• Won’t merge
• Submit ideas
• Set up the development environment
• Our code style
• Testing for errors
• Further questions

#Introduction

Hocuspocus 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 git@github.com:ueberdosis/hocuspocus.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!

Compile and watch for changes:

npm run build:watch

#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

Make sure all tests pass before sending a pull request. Your pull request will automatically execute all tests via the GitHub Workflow.

• Run all tests locally: $ npm run test
• Run all tests of a single package: $ npm run test -- tests/PACKAGE_NAME

#Further questions

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