Diviner Contributor Docs

Phorge Contributor Documentation
Updated 297 Days AgoPublic
Actions

Information for Phorge contributors and developers.

Contributor Overview

Contributor IntroductionArticleIntroduction to contributing to Phorge and Arcanist.

Contributing in Detail

Contributing Bug ReportsArticleDescribes how to file an effective Phorge bug report.Contributing CodeArticlePhorge is an open-source project, and welcomes contributions from the community at large. However, there are some guidelines we ask you to follow.Contributing Feature RequestsArticleDescribes how to file an effective Phorge feature request.Describing Root ProblemsArticleExplains how to describe a root problem effectively.Providing Reproduction StepsArticleDescribes how to provide reproduction steps.Providing Version InformationArticleHow to provide version information with reports made to the upstream.

Developer Guides

Adding New ClassesArticleGuide to adding new classes to extend Phorge.Adding New CSS and JSArticleExplains how to add new CSS and JS files to Phorge.Assistive TechnologiesArticleInformation about making Phorge accessible to assistive technologies.Celerity Technical DocumentationArticleTechnical overview of the Celerity system.Database SchemaArticleThis document describes key components of the database schema and should answer questions like how to store new types of data.Developer SetupArticleHow to configure a Phorge development environment.Handles Technical DocumentationArticleTechnical overview of Handles.InternationalizationArticleDescribes Phorge translation and localization.Performance: N+1 Query ProblemArticleHow to avoid a common performance pitfall.Phorge Code LayoutArticleGuide to Phorge code layout, including how URI mapping works through application class and subdirectory organization best practices.Rendering HTMLArticleRendering HTML in the Phorge environment.Running built-in PHP webserverArticleAs of version 5.4.0, the PHP command line interface provides a built-in web server. This web server is designed for developmental purposes only, and should not be used in production. Phorge can be executed under it with the command:Using EdgesArticleGuide to the Edges infrastructure.Using the Phorge OAuth ServerArticleHow to use the Phorge OAuth Server.Writing Unit TestsArticleSimple guide to Arcanist and Phorge unit tests.

Coding Standards

CSS Coding StandardsArticleThis document describes CSS features and coding standards for Phorge.General Coding StandardsArticleThis document is a general coding standard for contributing to Phorge, Arcanist, and Diviner.Javascript Coding StandardsArticleThis document describes Javascript coding standards for Phorge and Javelin.PHP Coding StandardsArticleThis document describes PHP coding standards for Phorge and related projects (like Arcanist).