zammad/doc/developer_manual/index.md

Developer Manual for Zammad

Welcome to the developer docs of Zammad. 👋 This is a work in progress, and you're encouraged to contribute and improve it.

Development Environment

• How to set up a development environment
• Getting started
• Basic information

Standards & Best Practices

• Code Style Guide
• How to design tests
• How to add a database migration
• How to add an SVG Icon
• How to handle localization & translations
• How to rebuild the chat
• How to use forms

Cookbook / Recipes

• How to diagnose email bugs
• How to setup S/MIME integration
• How to use debuggers with Zammad
• How to test with RSpec / Capybara
• How to test with QUnit
• How to test with Vitest and Cypress
• How to test the development version of Zammad via Docker

How to Contribute

We live & love Open Source and therefore we encourage our community to contribute to the development of Zammad.

You could simply to do this by fixing a reported issue or by implementing an enhancement.

For the workflow how to contribute, please check the official GitHub documentation.