Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Latest commit

 

History

History
50 lines (26 loc) · 1.52 KB

DEVELOPER.md

File metadata and controls

50 lines (26 loc) · 1.52 KB

Developers

Please also read (CONTRIBUTING.md)[CONTRIBUTING.md].

.editorconfig

Please make sure your editor uses our .editorconfig file. It contains rules about our coding styles.

Docker

To improve local development we have a Docker container on board. You can find it in /docker.

If you are on Linux, go to your terminal, switch to the docker folder and run:

make

This will build and start the docker container. After it started, you will be logged in automatically.

Afterwards you can run further commands on the CLI, like composer update or PHPUnit test suite.

Fuseki

You can run Fuseki inside the Docker container by calling the following on the Terminal:

bash test/start_fuseki.sh

It will start the server in the background. Wait a few seconds and then run PHPUnit as always.

Tests

Our test related files are located in test folder. Tests are written using PHPUnit.

Make sure you ran composer update, if you want to execute the test suite (Getting Started).

To run all tests, open your terminal and run:

make test-lib

Travis

We use Travis to run tests automatically after new code is being received by Github (library and examples):

Link: https://travis-ci.com/github/easyrdf/easyrdf

After you made a pull request, use Travis to check the test result.

Important notes

  • Don't rely on our test API, like functions or classes! They are only for internal use. If you want certain functionality be part of the public API, please create an issue.