This document describes development workflows and maintenance tasks for the project.
To keep configuration files synchronized with the latest template updates, use the sync-metadata command. This command
downloads the latest configuration files from the template repository.
composer run sync-metadataThis command updates the following configuration files:
| File | Purpose |
|---|---|
.editorconfig |
Editor settings and code style configuration |
.gitattributes |
Git attributes and file handling rules |
.gitignore |
Git ignore patterns and exclusions |
This package exposes shared configuration files under config/.
Consumer repositories should create wrapper config files at their repository root
and import these shared configs.
Run this command in the following scenarios:
- Periodic Updates - Monthly or quarterly to benefit from template improvements.
- After Template Updates - When the template repository has new configuration improvements.
- Before Major Releases - Ensure your project uses the latest best practices.
- When Issues Occur - If configuration files become outdated or incompatible.
- This command overwrites existing configuration files with the latest versions from the template.
- Ensure you have committed any custom configuration changes before running this command.
- Review the updated files after syncing to ensure they work with your specific project needs.
- Some projects may require customizations after syncing configuration files.