Contributing to Jovo
Learn more about setting up your Jovo development environment and contributing to the open source framework by submitting pull requests on GitHub.
Jovo is open source under an Apache 2.0 license, which means that the source code is openly available and a community of contributors helps us add new features, fix bugs, and write documentation. Financial contributors also help our core team focus on building new features and supporting the community.
jovo-framework repository uses a monorepo structure that contains all packages needed for development. There is also a
docs folder that contains all general documentation. Each integration also contains its own
docs folder with documentation for the respective pages in the Jovo Marketplace. For example, all Alexa docs can be found in
If you want to contribute to Jovo, you can learn more in the sections below:
- Development setup: Learn how to run the Jovo code locally
- PR Workflow: All the steps needed to contribute to Jovo by submitting a pull request (PR) on GitHub
To clone and run the Jovo Framework code, use the following commands:
# Clone jovo-framework repository (this could also be your fork) $ git clone https://github.com/jovotech/jovo-framework.git # Go into the framework directory $ cd jovo-framework # Install dependencies $ npm install # Run setup script $ npm run setup:dev
setup:dev script is responsible for linking all packages of the repository together and compiling each package's source code. To learn more about all scripts, take a look at the
If you want to test your updates, we recommend using a project in the
examples folder. The examples are linked with the local packages of the
If you are making updates to a specific package in the repository, make sure that its content is compiled before testing:
## Package folder, e.g. integrations/db-dynamodb # Build files of updated package $ npm run build # Alternative: Watch package and build on file change $ npm run watch
In the example project, you can run and watch the code like this and then test it in the Jovo Debugger:
## Example folder, e.g. examples/typescript/basic # Run (and watch) Jovo src files $ npm run start:dev
If you want to contribute to the Jovo open source code by opening a pull request (PR), you can learn more about all steps of the workflow in the sections below:
If you're new to working with PRs and GitHub, you can learn more by going through this repository: first-contributions.
We use the following conventions for branches:
v4/latest: This branch is up to date with the latest version on npm and the docs on the Jovo website. Docs-only PRs should point to this branch.
v4/dev: The main branch for development before a new version gets released on npm. Most PRs should point to this branch.
We follow the feature branch workflow, which means that each PR gets its own branch, that can be named like this:
For example, if you want to create a new feature or fix a bug, you can create a new branch from
v4/dev like this:
$ git checkout -b v4/feature/<name> origin/v4/dev # Example $ git checkout -b v4/feature/alexa-audioplayer origin/v4/dev
For docs, you can create a new brach from
v4/latest like this:
$ git checkout -b v4/docs/<name> origin/v4/latest # Example $ git checkout -b v4/docs/alexa-improvements origin/v4/latest
There is no strict convention for branch names. If it is for an integration (like a platform), we usually add the integration name at the beginning, for example:
We use gitmoji for our commit messages. The convention is to have a commit for each isolated change. This way, commits can be scanned more easily by other contributors.
Here are a few examples:
# Docs :memo: Add account linking section # Feature :sparkles: Add LinkAccountCardOutput # Bug :bug: Fix user session bug
v4/devfor code changes
v4/latestfor changes to the docs only
Please also check the allow changes from maintainers option for the core team to make updates during review.
Merge and Release
A PR will be merged once it passes the following two review steps:
- Code review: This ensures that the code works and follows our conventions. This is usually done by Alex.
- Doc review: This ensures that all added features are documented. This is usually done by Jan.
We are very thankful for each contribution and are working hard on merging PRs as soon as possible, but please be considerate that each review takes time and work on our side. The more community members ask for a feature, the higher we can prioritize the work we put into the PR for it. PRs submitted by financial contributors are also prioritized. We reserve the right to close PRs if they don't fit our strategy or process.
After the review, we merge the PR and usually publish updates to npm 2-3 times a month. Bugfixes get released faster.
Thank you for your contribution!