Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information about building #277

Merged
merged 2 commits into from Jun 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions Documentation/BugfixingAZ/Index.rst
Expand Up @@ -70,6 +70,9 @@ as described in :ref:`setup <setup>`. Especially the
For new features, breaking changes and deprecations, it is necessary to :ref:`add
information to the changelog <changelog>`.

If you change SCSS, JavaScript or TypeScript files, you can :ref:`build <build>`
locally.

Add Unit Tests or Functional Tests for new functionality, refine existing tests
if necessary. Tests are important because they ensure that
TYPO3 will behave consistently now and in the future.
Expand Down
37 changes: 37 additions & 0 deletions Documentation/Build/Index.rst
@@ -0,0 +1,37 @@
. include:: /Includes.rst.txt

.. highlight:: bash

.. index::
single: Code Contribution Workflow; Build
single: Build
single: SCSS
single: TypeScript
.. _build:

===============
Building assets
===============

This page explains building assets like JavaScript and CSS files.

For the most part, the TypeScript, JavaScript and SCSS sources are contained in
:file:`Build/Sources`. These are compiled to target files, usually located in:

* CSS: :file:`typo3/sysext/*/Resources/Public/Css`
* JavaScript: :file:`typo3/sysext/*/Resources/Public/JavaScript`

If you make changes to the source files, you can build locally using
:ref:`runTests.sh <runTests_sh>`:

.. code-block:: bash

Build/Scripts/runTests.sh -s buildCss
Build/Scripts/runTests.sh -s buildJavascript

It is also possible to lint the files locally:

.. code-block:: bash

Build/Scripts/runTests.sh -s lintScss
Build/Scripts/runTests.sh -s lintTypescript
1 change: 1 addition & 0 deletions Documentation/Index.rst
Expand Up @@ -65,6 +65,7 @@ On these pages you will learn how to become a TYPO3 Core contributor.

ReportingAnIssue/Index
BugfixingAZ/Index
Build/Index
AddingDocumentation/Index
Testing/Index
DebuggingTypo3/Index
Expand Down