Skip to main content
Version: 4.x

Contributing Guide

This guide will help you get started with Zealot! Thank you for taking an interest in contributing to Zealot. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

This guide will help you to install and setup a production ready Zealot.

Getting Started

Before starting your work, ensure an issue exist for it. If not feel free to create one. You can also take a look into the issues tagged Good first issues. Add a comment on the issue and wait for the issue to be assigned before you start working on it. This helps to avoid multiple people working on similar issues. If the solution is complex, propose the solution on the issue and wait for one of the core contributors to approve before going into the implementation. This helps in shorter turn around times in merging PRs For new feature requests, Provide a convincing reason to add this feature. Real-life business use-cases will be super helpful. Feel free to join our discord community, if you need further discussions with the core team.

Setup for local development

These guides will help you to setup the environment required for Zealot. Follow the guide based on the operating system you use.