You are here: start » en » Internal Documentation » Working with projects » Set up a development environment

Set up a development environment

Prerequisites

Tool Requirement For what
Git client any, HTTP-Basic capable fetching and returning source
PHP 8.2 or later syntax checking and test runs
Composer current installing the checking tools
Access token your own, valid authenticating the Git client
Write permission on the repository's namespace giving changes back

Up to and including step 3 — reading, cloning, building and testing — the level obtain suffices, which the mount public grants to everybody. Only giving back needs more, and how much more is at Submit a change. Where it is missing, the way onward is Request access.

Step 1: create an access token

Create a personal token and keep it ready: Access tokens. In full at Create an access token.

Step 2: clone the repository

Copy the clone address from the section Dieses Repository beziehen of the repository you want, and clone with it:

git clone <paste the copied address here>

The token serves as the password; the user name is not checked. In full at Clone a repository.

Step 3: set up the checking tools

This holding's packages are checked against two tools. Both are declared as development dependencies and are installed in the workspace that carries the composer.json:

composer install
Call What it checks
composer cs coding style to PSR-12, without rule exceptions
composer cbf fixes mechanically fixable style findings
composer stan static analysis

Step 4: check what you changed

Five controls apply after every change. They are this holding's binding acceptance:

  1. A syntax check over every changed file (php -l).
  2. A boot run of the wiki.
  3. Completeness of the interface texts in all five languages — German, English, Italian, Croatian, Slovenian — including a placeholder check.
  4. A rebuild of the CSS bundle.
  5. A comparison of the error log before and after the change.

Expected result

A local working copy that clones, checks and builds, and a Git client that authenticates at the endpoint without asking for a password again.

Next steps

en/wiki/projects/development-setup.txt · Last modified: by 0.0.0.0