https://github.com/figuren-theater/code-quality
Development tools to measure and test the code quality of figuren.theater, the WordPress Multisite network for puppeteers.
https://github.com/figuren-theater/code-quality
Last synced: 2 months ago
JSON representation
Development tools to measure and test the code quality of figuren.theater, the WordPress Multisite network for puppeteers.
- Host: GitHub
- URL: https://github.com/figuren-theater/code-quality
- Owner: figuren-theater
- License: gpl-3.0
- Created: 2023-06-20T08:15:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T11:45:16.000Z (6 months ago)
- Last Synced: 2024-12-30T12:03:19.414Z (6 months ago)
- Homepage:
- Size: 256 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
figuren.theater | Code Quality
Development tools to measure and test the code quality of figuren.theater, the WordPress Multisite network for puppeteers.
Read our blog
See the network in action
•
Join the network
•
Create your own network
## About
This is the long desc
* [x] *list closed tracking-issues or `docs` files here*
* [ ] Do you have any [ideas](https://github.com/figuren-theater/code-quality/issues/new) ?
## Background & Motivation
See the workflow running for the figuren.theater platform
||Repo|Code Quality|
|-:|-|-|
| 1. |[ft-admin-ui](https://github.com/figuren-theater/ft-admin-ui/)| [](https://github.com/figuren-theater/ft-admin-ui/actions/workflows/build-test-measure.yml) |
| 2. |[ft-core](https://github.com/figuren-theater/ft-core/)| [](https://github.com/figuren-theater/ft-core/actions/workflows/build-test-measure.yml) |
| 3. |[ft-coresites](https://github.com/figuren-theater/ft-coresites)| |
| 4. |[ft-data](https://github.com/figuren-theater/ft-data)| |
| 5. | └── [ft-network-sourcelinks](https://github.com/figuren-theater/ft-network-sourcelinks)| |
| 6. |[ft-interactive](https://github.com/figuren-theater/ft-interactive)| [](https://github.com/figuren-theater/ft-interactive/actions/workflows/build-test-measure.yml) |
| 7. |[ft-maintenance](https://github.com/figuren-theater/ft-maintenance)| [](https://github.com/figuren-theater/ft-maintenance/actions/workflows/build-test-measure.yml) |
| 8. |[ft-media](https://github.com/figuren-theater/ft-media)| [](https://github.com/figuren-theater/ft-media/actions/workflows/build-test-measure.yml) |
| 9. |[ft-onboarding](https://github.com/figuren-theater/ft-onboarding)| [](https://github.com/figuren-theater/ft-onboarding/actions/workflows/build-test-measure.yml) |
| 10.| ├── [ft-core-block-domaincheck](https://github.com/figuren-theater/ft-core-block-domaincheck)| |
| 11.| └── [install.php](https://github.com/figuren-theater/install.php/)| [](https://github.com/figuren-theater/install.php/actions/workflows/build-test-measure.yml) |
| 12.|[ft-options](https://github.com/figuren-theater/ft-options)| [](https://github.com/figuren-theater/ft-options/actions/workflows/build-test-measure.yml) |
| 13.|[ft-performance](https://github.com/figuren-theater/ft-performance/)| [](https://github.com/figuren-theater/ft-performance/actions/workflows/build-test-measure.yml) |
| 14.|[ft-platform](https://github.com/figuren-theater/ft-platform/)| [](https://github.com/figuren-theater/ft-platform/actions/workflows/build-test-measure.yml) |
| 15.|[ft-platform-collection](https://github.com/figuren-theater/ft-platform-collection/)| [](https://github.com/figuren-theater/ft-platform-collection/actions/workflows/build-test-measure.yml) |
| 16.|[ft-privacy](https://github.com/figuren-theater/ft-privacy)| [](https://github.com/figuren-theater/ft-privacy/actions/workflows/build-test-measure.yml) |
| 17.|[ft-routes](https://github.com/figuren-theater/ft-routes)| [](https://github.com/figuren-theater/ft-routes/actions/workflows/build-test-measure.yml) |
| 18.|[ft-security](https://github.com/figuren-theater/ft-security)| [](https://github.com/figuren-theater/ft-security/actions/workflows/build-test-measure.yml) |
| 19.|[ft-seo](https://github.com/figuren-theater/ft-seo)| [](https://github.com/figuren-theater/ft-seo/actions/workflows/build-test-measure.yml) |
| 20.|[ft-site-editing](https://github.com/figuren-theater/ft-site-editing)| [](https://github.com/figuren-theater/ft-site-editing/actions/workflows/build-test-measure.yml) |
| 21.| ├── [ft-network-block-editor](https://github.com/figuren-theater/ft-network-block-editor)| [](https://github.com/figuren-theater/ft-network-block-editor/actions/workflows/build-test-measure.yml) |
| 22.| └── [ft-network-block-patterns](https://github.com/figuren-theater/ft-network-block-patterns)| [](https://github.com/figuren-theater/ft-network-block-patterns/actions/workflows/build-test-measure.yml) |
| 23.|[ft-theater](https://github.com/figuren-theater/ft-theater)| [](https://github.com/figuren-theater/ft-theater/actions/workflows/build-test-measure.yml) |
| 24.| ├── [label-printing](https://github.com/figuren-theater/label-printing)| [](https://github.com/figuren-theater/label-printing/actions/workflows/build-test-measure.yml) |
| 25.| ├── [theater-production-blocks](https://github.com/figuren-theater/theater-production-blocks)| [](https://github.com/figuren-theater/theater-production-blocks/actions/workflows/build-test-measure.yml) |
| 25.| └── [theater-production-subsites](https://github.com/figuren-theater/theater-production-subsites)| [](https://github.com/figuren-theater/theater-production-subsites/actions/workflows/build-test-measure.yml) |
| 26.|[ft-themes](https://github.com/figuren-theater/ft-themes)| [](https://github.com/figuren-theater/ft-themes/actions/workflows/build-test-measure.yml) |
| 27.|[ft-theming](https://github.com/figuren-theater/ft-theming)| [](https://github.com/figuren-theater/ft-theming/actions/workflows/build-test-measure.yml) |
| 28.|[.github](https://github.com/figuren-theater/.github/)| [](https://github.com/figuren-theater/.github/actions/workflows/build-test-measure.yml) |
| 29.|[code-quality](https://github.com/figuren-theater/code-quality/)| [](https://github.com/figuren-theater/code-quality/actions/workflows/build-test-measure.yml) |
| 30.| ├── [phpstan](https://github.com/figuren-theater/phpstan)| *(No Build, no tests :)* |
| 31.| └── [coding-standards](https://github.com/figuren-theater/coding-standards/)| [](https://github.com/figuren-theater/coding-standards/actions/workflows/build-test-measure.yml) |
| 32.|[new-ft-module](https://github.com/figuren-theater/new-ft-module/)| [](https://github.com/figuren-theater/new-ft-module/actions/workflows/build-test-measure.yml) |
| 33.|[status.figuren.theater](https://github.com/figuren-theater/status.figuren.theater)| |
| 34.|[BLOGS](https://github.com/figuren-theater/BLOGS)| |
| 35.| ├── [websites.fuer.figuren.theater/demos](https://github.com/figuren-theater/websites.fuer.figuren.theater-demos)| |
| 36.| └── [katharina-muschiol.de](https://github.com/figuren-theater/katharina-muschiol.de/)| |
## Install
1. Install via command line
```sh
composer require --dev figuren-theater/code-quality@*
```
2. Create a [phpstan.neon](https://github.com/figuren-theater/new-ft-module/blob/main/phpstan.neon) file in the root of the repository
3. Create a [.phpcs.xml](https://github.com/figuren-theater/new-ft-module/blob/main/.phpcs.xml) file in the root of the repository
## Usage
```sh
composer normalize
```
```sh
vendor/bin/phpstan analyse -nvv
```
```sh
vendor/bin/phpcs . -v
```
## Built with & uses
- [dependabot](/.github/dependabot.yml)
- [figuren-theater/coding-standards](https://github.com/figuren-theater/coding-standards/)
- [figuren-theater/phpstan](https://github.com/figuren-theater/phpstan/)
- [composer normalize](https://github.com/ergebnis/composer-normalize)
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Versioning
We use [Semantic Versioning](http://semver.org/). For the versions
available, see the [tags on this repository](https://github.com/figuren-theater/code-quality/tags).
## Authors
- **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
See also the list of [contributors](https://github.com/figuren-theater/code-quality/contributors)
who participated in this project.
## License
This project is licensed under the **GPL-3.0-or-later**, see the [LICENSE](/LICENSE) file for
details
## Acknowledgments
- [@szepeviktor](https://github.com/szepeviktor) for all wonderful sharings over the last years especially everything related coding-standards and semi-automated tests.
- [altis](https://github.com/search?q=org%3Ahumanmade+altis) by humanmade, as our digital role model and inspiration
- [@roborourke](https://github.com/roborourke) for his clear & understandable [coding guidelines](https://docs.altis-dxp.com/guides/code-review/standards/)
- [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow