Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.2 KB

data_template's

Pushes to master branch require successful pass of tests.

Tests can be executed using composer test, NOTE composer and PHP 7 is required see README. Or they are automatically executed on commits at Travis CI The test validate's the definition of JSON schema in data_template/ directory.

New data template MUST follow the specification available at specification/data_template.md

When witting additional specifications and features additional tests must be written.

When changing file files or file structure at data_template, before creating a push request "generate new index.json" MUST be executed to generate a fresh index.json

execute

composer generate

Push requests with failed CI build status cannot be accepted.

JSON

  • JSON files must be formatted using "pretty print" with 2 spaces indentation.

PHP Validator and tests

All php code MUST follow