---
title: "Contribution"
version: "main"
source: "Contribution/Index.rst"
modified: "2026-09-14T15:00:59+00:00"
---

# Contribution

Feel free to create an issue or fork this project and create a pull request
when you're happy with your changes.

**Table of Contents:**

-   [Bug reporting](#bug-reporting)
-   [Clean code](#clean-code)
-   [Local environment](#local-environment)
-   [Build the frontend files](#build-the-frontend-files)
-   [License](#license)
-   [Slack](#slack)

## Bug reporting

Please open an [issue at GitHub](https://github.com/benjaminkott/bootstrap_package/issues) and describe your problem.

## Clean code

We check the source code according to the our Coding Guidelines. To reformat
the code automatically, you can use *PHP CS Fixer* as follows:

```bash
composer cgl
```

## Local environment

The extension comes with a ready to use DDEV Local configuration. Type
`ddev start` in the extension root folder to start the Docker container.

`ddev launch` will open the browser and head to the testing website. You can
use `ddev launch typo3` to get directly to the backend.

`composer install` resolves the newest TYPO3 release the extension
declares. The local installation runs on the TYPO3 development major
instead, which `composer typo3:dev` resolves without touching
`composer.json`:

```bash
ddev composer typo3:dev
```

## Build the frontend files

When you change any of the SCSS files, the combined and minified versions
of the CSS have to be rebuilt.

You can run them like this:

```bash
cd Build
npm ci
npm run build
```

Then commit any changes to files in folder `Resources/Public/Css`. If you
omit any of these steps the pipeline of the automatic checks fails for
"build-frontend".

## License

This project is released under the terms of the [MIT license](https://en.wikipedia.org/wiki/MIT_License).

## Slack

You can connect directly with us on [Slack](https://typo3.slack.com/messages/bootstrap-package/), the preferred instant
communication platform of TYPO3 CMS developers. If you already have access to
the TYPO3 Slack platform join the #bootstrap-package channel. If you don't have
access yet, you can register at [my.typo3.org](https://my.typo3.org/about-mytypo3org/slack).

X
=

If you have any questions about this project or just want to talk:
Send a tweet [@benjaminkott](https://x.com/benjaminkott).