Contribution Guide

Introduction

Faveo Helpdesk is an open-source project and anyone may contribute to Faveo for its improvement. We welcome contributors, regardless of skill level, gender, race, religion, or nationality. Having a diverse, vibrant community is one of the core values of the framework!

The Faveo source code is managed on Github

To Contribute to Faveo Helpdesk open source version, do read and follow below guidelines

Guides

Code of conduct: https://github.com/ladybirdweb/faveo-helpdesk/blob/master/code_of_conduct.md

Programming standards: https://github.com/ladybirdweb/faveo-helpdesk/wiki/Programming-Standards

Code of conduct: https://github.com/ladybirdweb/faveo-helpdesk/blob/master/code_of_conduct.md

PHP IDE & Debugging for Laravel: https://github.com/ladybirdweb/faveo-helpdesk/wiki/PHP-IDE-&-Debugging-for-Laravel

Plugin creation: https://github.com/ladybirdweb/faveo-helpdesk/wiki/Faveo-Plugin-creation-guide

API: https://github.com/ladybirdweb/faveo-helpdesk/wiki/API-Documentation

Event list: https://github.com/ladybirdweb/faveo-helpdesk/wiki/Faveo-Event-List

Core Development Discussion

Discussion regarding bugs, new features, and implementation of existing features takes place in the Skype group.

Skype Group: https://join.skype.com/SrIvZgWiFDEN

Slack Channel: https://faveocommunity.slack.com/

New Features

Before sending pull requests for new features, please contact us via the Skype Group. If the feature is found to be a good fit for the application, you are free to make a pull request. If the feature is rejected, don't give up! You are still free to turn your feature into a package which can be released to the world via Packagist.

When adding new features, don't forget to add unit tests! Unit tests help ensure the stability and reliability of the framework as new features are added.

Bugs

Via Unit Test

Pull requests for bugs may be sent without prior discussion with the Faveo development team. When submitting a bug fix, try to include a unit test that ensures the bug never appears again!

If you believe you have found a bug in Faveo, but are unsure how to fix it, please send a pull request containing a failing unit test. A failing unit test provides the development team "proof" that the bug exists, and, after the development team addresses the bug, serves as a reliable indicator that the bug remains fixed.

If are unsure how to write a failing unit test for a bug, review the other unit tests included with the application. If you're still lost, you may ask for help in the Skype group.

Which Branch?

Development Branch: https://github.com/ladybirdweb/faveo-helpdesk/tree/development

All bug fixes & new features should be sent to the Development branch.