Revision as of 18:04, 29 October 2016

Development

Standards

The PHP-FIG standards will be used:

• PSR-1 and PSR-2 Coding Standards
• PSR-3 Logging Interface for interchangeable logging objects
• PSR-4 Auto-Loading Standard
• Symfony HTTP Foundation for interchangeable Request/Response objects
• PSR-7 HTTP Message Interface for interchangeable Request/Response objects if required for some components
• All files will be UTF8 using UNIX LF

Components

Components will be carefully chosen to be well supported, stable, and interchangeable wherever possible.

PHP Autoloading

PSR-4 is used for packaging, namespace and auto-loading of OO code.

• Composer will be required for dependency management and PSR-4 auto-loading
• All external libraries will be installed by Composer under vendor/
• All OO classes will be namespaced under ARK\
• All OO code will be under src/ and not php/ (this will also clearly separate new code from old)

A good series of articles explaining PSR-4 and modern development and packaging in general can be found at the following:

• http://culttt.com/2013/01/07/what-is-php-composer/
• http://culttt.com/2014/03/12/build-php-package/
• http://culttt.com/2014/05/07/create-psr-4-php-package/

Git / Github

Development is hosted on Github, so you will need a free Github account to contribute code.

If you are new to Git, you may find the Github desktop application easier to use. Alternatives are SourceTree and GitKraken.

We will use a simplifed version of the Qt git workflow.

• dev branch is the semi-stable development branch for the next release
• New feature or bugfix branches are branched off dev with the name of the author/group/client and the feature or bug number, e.g. jlayt/linked-data
• Once a new feature is finished and passes testing, it is rebased onto the current dev and merged via a Github merge request with review
• Alpha and Beta testing releases will be tagged on dev and not branched
• Once dev is deemed feature complete and stable enough for a Release Candidate then a release branch will be branched off dev with the minor release number, e.g. release/2.0, release/2.1, etc
• Further testing will take place on the release branch, with fixes applied to to the release branch as required
• Once ready for release, the release will be tagged with the point release number (e.g. 2.0.0) and all bugfixes merged back into dev
• Any bugfixes for the stable release will be made in the earliest release branch they apply to and then merged forward through each release then eventually into dev (merges may be immediate or periodic depending on the volume)

Environment

To develop ARK requires the following tools to be installed:

• Git
• Composer
• Node.js (for frontend/theme development only)

You will also require PHP, a web server (Apache/PHP), a database server (MySQL/PostreSQL/SQLite), and a web browser (Chrome/Firefox).

The following tools are recommend to adhere to ARK code quality standards:

• php-cs-fixer
• PHP CodeSniffer
• PHP MD

macOS

On macOS, while you can install the requirements via standalone packages, we recommend using HomeBrew as it makes installing and updating all the tools used easier.

• Install XCode
• Install the Command Line Tools (includes Git)
• Download and install HomeBrew

• brew install node tidy-html5 homebrew/php/composer homebrew/completions/composer-completion homebrew/php/php-cs-fixer homebrew/php/php-code-sniffer homebrew/php/phpmd homebrew/php/sqlformat homebrew/php/phplint

• npm install -g bootlint csscomb csslint eslint js-beautify jsonlint prettydiff remark-lint sass-lint tidy-markdown

• (Optional) Modify your .profile to enable command-line auto-complete

export HOMEBREW_GITHUB_API_TOKEN="token"
source /Library/Developer/CommandLineTools/usr/share/git-core/git-completion.bash
source /Library/Developer/CommandLineTools/usr/share/git-core/git-prompt.sh
GIT_PS1_SHOWDIRTYSTATE=true
PS1='\u@\h \W$(__git_ps1 " (%s)") \$ '
export PATH=/Users/odysseus/.bin:$PATH

The easiest way to run a webserver and database server is using MAMP. Simply install MAMP and create a soft-link from the MAMP webroot to the location of your ARK git repository. The alternative is to use HomeBrew to configure and run your own install. The HomeBrew method is recommended for developing with PostgreSQL (TODO).

• brew install homebrew/php/php70 homebrew/php/php70-tidy homebrew/php/php70-xdebug

For QGIS Python:

• 'brew install python qt pyqt'
• 'pip install pep8 autopep8 jedi pb_tool '

TODO

• xdebug setup
• apache / php /mysql / mamp
• linter/fixer rulesets

Atom Editor

While text editors and IDEs are a deeply personal choice, we recommend using Atom as it is a cross-platform Open Source editor with powerful plugins to support the tools used by ARK. Using Atom ensures you have an environment consistent with the core ARK developers and ARK development standards.

After installing Atom, check the commandline tools have been installed.

Recommended Atom Packages:

• 'apm install atom-autocomplete-php atom-beautify atom-bootstrap3 atom-symfony2 autocomplete-sass doctrine linter-bootlint linter-csslint linter-eslint linter-jsonlint linter-markdown linter-php linter-phpcs linter-phpmd linter-sass-lint linter-tidy linter-twig php-composer-completion php-cs-fixer php-debug php-twig symfony-snippets'

Useful Atom Packages:

• sublime-style-column-selection
• autoclose-html
• browser-plus
• docblockr
• git-plus
• highlight-line
• highlight-selected
• minimap
• open-recent
• pigments
• platformio-ide-terminal
• project-manager
• sort-lines
• sync-settings