Skip to end of metadata
Go to start of metadata

FreePBX Development


 

FreePBX is a true Open Source development effort. Providing GNU GPL v2+ licensing (or equivalent) is all that is required to make a project Open Source. However, obtaining true community involvement is what makes a good project become great. This means transparent access to the project's activities and a development community with access to the project that is not limited to a sponsoring organization. These values are what fuel a really successful project.

The FreePBX Project uses the Atlassian JIRA application in order to tightly integrate the GIT Activity, Ticket system and Development Wiki. We have integrated this system with the main site so that you are signed on to both sites when you create an account and login to the system. Without an account, you will not be able to submit tickets but will have access to view everything.

Icon

To participate in the FreePBX project you must agree and submit a filled out copy of our code submission agreement: http://literature.schmoozecom.com/EUA/CodeSubmissionsAgreement-r3.pdf (For more information on this Please see our FAQ)

Getting Started

The easiest way to get started is to simply take a look at our bug tracker. We have over 772 issues currently open for FreePBX alone.

Accessing The source

Please take a look at our development documentation for setting up a development environment here: Setting Up a Development Environment

Browsing The Source

You can take a quick look at the source here: http://code.freepbx.org/project/FREEPBX

Here is a list of the last 5 commits made to the FreePBX Project

FreePBX_ucp (release/12.0): prevent message stacking by using a message buffer
Andrew Nagy committed 4b79097 on branch master, develop, release/12.0 in FreePBX_ucp
prevent message stacking by using a message buffer

· /Ucp.class.php (-0, +57) | History | Source | Diff
· /htdocs/assets/js/ucp.js (-21, +47) | History | Source | Diff
· /module.xml (-1, +7) | History | Source | Diff
FREEPBX-48: comment by The James "fixed"
The James replied to Bryan Walters in FREEPBX-48

fixed

FreePBX_core (FREEPBX-4095): Fire the beeb replace with beep
The James committed c01c38b on branch FREEPBX-4095 in FreePBX_core
Fire the beeb replace with beep

· /functions.inc.php (-1, +1) | History | Source | Diff
FREEPBX-48: comment by Bryan Walters "Pretty sure we mean beep here, not beeb"
Bryan Walters commented on FREEPBX-48

Pretty sure we mean beep here, not beeb

FREEPBX-45: comment by Andrew Nagy "[~GameGamer43] you also need to do this for 12 ..."
Andrew Nagy commented on FREEPBX-45

Bryan Walters you also need to do this for 12 for the shared object you are trying to add (unless preload isn't needed)

Community Design and Development

In addition to taking input and feedback from the community at large, FreePBX tries to keep its design and road map plans transparent and accessible. This means ideas are discussed in the Forum, in the Wiki and in the #freepbx-dev IRC channel. Live interaction can also be extremely beneficial, so many phone conversations do take place (after all we are all about phones...). We try hard to document the content of these conversations into the Wiki to further benefit from community review and input.

Getting Involved

The Development Wiki lists many ways to get involved. If you want to develop a good way to start is to contact one of the active developers. You can PM them, or you can get onto the Development IRC channel #freepbx-dev on Freenode and make contact. 

We have recently transitioned to GIT which makes getting involved much easier.  To assist in bug fixes and improvements you may fork one of the submodules on Github at https://github.com/FreePBX/ or https://github.com/FreePBX-ContributedModules. Once you have your code tested and working you can submit a pull request or submit a patch after you have fully completed our CSA on file. All bug fixes and feature requests should relate to a ticket at http://issues.freepbx.org.  If you have written a module you would like included in our contributed repo (https://github.com/FreePBX-ContributedModules) simply create a repo for your module on Github then open a ticket in the bug tracker to make us aware of it and we can mirror your repo.  Remember all code submissions through the bug tracker or through git require a CSA on file.  If you are new to GIT please see our wiki for a general overview.

Beyond code development there are many ways that you can help. Translations are important and you do not need to be a developer to help in this area. For information on translating go here.

We are aware that there are parts of the code with some limitations today that you might run into. We will work with you on those. 

Bug marshals and testing: As bugs get reported, it can be extremely helpful to have some testers who are able to review the bugs, confirm the issues, request additional information from the reporters and in general help us filter the bug reports and prioritize them. Get in touch with the core team if this is something you can help with.

Documentation, Documentation, Documentation

The more quality documentation that exists in a project, the more useful and valuable it becomes. This includes creating original content whether it be How-To Guides, Module Documentation or other forms. It also includes editing existing documentation for correctness and completeness and helping to get the site into a more standardized and organized form. If you have expertise in this area and would like to help drive it, please contact us.

Development Documentation is critical as well. If you are a developer, you probably know that this can be a weak point for many. There is a lot of information on the Development Wiki but it is also a priority of ours to put some effort into cleaning and updating the documentation, organizing it and augmenting it to make it easier for new developers to get involved.

A Note about Third Party Module Development

Icon

New module submissions are a regularly occurring event and you will find many modules that have been submitted as tarballs in the Ticket system that are not available in the online system. Why is that?

The FreePBX project is designed as a Framework that can easily accommodate new modules and for that reason, new modules get written and submitted. This does not mean that we put every module that comes along into the project. As the project has matured and stabilized, we are putting a lot more thought into the architecting of the FreePBX as it continues to evolve and mature into a world class product. In order to do that, we need to carefully evaluate what officially enters the system since adopting a module has many implications. We try very hard once something becomes part of the project to take on the commitment of maintaining and supporting it and making sure that future upgrades of the project will continue to work with the Modules that are part of it. If you are thinking about writing a module that you would like to be part of the core project, you should talk with one of the active developers in advance.

This does not mean that the other modules are less valuable or inferior in any way, if we don't adopt them. If you have written a module you would like included in our contributed repo simply create a repo for your module on github. Open a ticket in the bug tracker to make us aware of it and we can mirror your repo.  Remember all code submissions through the bug tracker or through git require a CSA on file.  If you are new to git please see our wiki for a general overview.

 

 

  • No labels