Skip to content

Commit 3bc03c6

Browse files
authored
[DOCS] Update README.md with dev hints (#20)
1 parent 99657c0 commit 3bc03c6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,25 @@ This package is not meant to be updated regularly, since talking about coding
105105
guidelines takes a lot of time, and is usual a matter of taste. Nonetheless,
106106
you can always open up an issue if you feel like we're missing out on something.
107107

108+
### Development
109+
110+
A GitHub action automatically synchronizes the files with the TYPO3 Core. Please
111+
do not open pull requests for these changes, but push your changes to the
112+
TYPO3 Core.
113+
114+
The source code comes with a DDEV Local configuration that makes using Composer
115+
and switching PHP versions very easy. For more information about DDEV, see the
116+
[documentation](https://ddev.readthedocs.io).
117+
118+
In the `composer.json` many scripts are predefined to run the CI locally before
119+
you push erroneous changes. Additionally some fix commands are integrated.
120+
121+
#### Manually update the files from the core
122+
123+
The synchronization job is scheduled once per night. It can also be started
124+
manually on the `Actions` tab on GitHub by selecting `Core Synchronization` and
125+
running the workflow on the main branch.
126+
108127
## License & Thanks
109128

110129
This package is available under the MIT license, since it relies heavily on the

0 commit comments

Comments
 (0)