DevelopersBible

This is the gateway to all documentation used day to day by developers. Read the Project Overview and follow Getting Started if you are new to the game.

Basic process and tools

• Where code and releases are. Where to install plugins and contribs from. What's stable/unstable/in development/experimental.
• git Repository
• Foswiki installed as GIT checkout - all developers need this.
• Unit test framework
• PublishedAPI - The Foswiki API and the DeprecationProcess that governs it.
• ReleaseNumbering - Documentation on how to assign Foswiki and Extension version and release.
• How To Start Extension Development In Git

• Feature Proposals

• Building a release

Guidelines

General

• Responsibilities of all developers
• Good behavior for extension developers

• Keeping track of all Foswiki authors
• Using jQuery with Foswiki

Documentation

• What to document and where it fits within the overall Foswiki documentation
• Creating a customized step-by-step installation guide

• How to write better copy
• Language usage guide

Coding Style

• Coding style
• Release Numbering
• Perl critic perl style checker
• Foswiki Coding Conventions

Technical Articles

• Technical Overview
• From Store to Browser - how a topic gets rendered for view
• How to develop plugins (system documentation shipped with Foswiki)
• How to develop secure extensions for Foswiki
• How to integrate with request validation
• How to develop components compatible with TWiki
• How to transform TWiki extensions to Foswiki extensions
• How to add REST and macro handlers to Contribs
• Sorting with Sort::Maker
• HowToCreateALocalExtensionRepository
• Strategy for regular expression support
• Important information about Foswiki::Func::addToZone() from plugin handlers
• How to write a .spec file
• Feature articles
  • Foswiki stand alone
  • Thin prefs

Translations

• Internationalisation guidelines
• UserInterfaceInternationalisation - How to use MAKETEXT and how to generate .po files
• Translation of the User Interface - step by step guide for the translators

Testing

• Developers Feature Test Checklist - A mind jogger for what to test when making code changes to core code

Pushing the Envelope

When someone does something new or scary, and writes up their experiences, then link the article here

• Notes on Java applets