|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -Thanks for considering contributing to this extension! :slightly_smiling_face: |
| 3 | +Please have a look in the [official documentation][1]. |
4 | 4 |
|
5 | | -Since it is an open source product, its successful further development |
6 | | -depends largely on improving and optimizing it together. |
7 | | - |
8 | | -The development of this extension follows the official |
9 | | -[TYPO3 coding standards](https://github.com/TYPO3/coding-standards). |
10 | | -To ensure the stability and cleanliness of the code, various code |
11 | | -quality tools are used and most components are covered with test |
12 | | -cases. |
13 | | - |
14 | | -## Create an issue first |
15 | | - |
16 | | -Before you start working on the extension, please create an issue on |
17 | | -GitHub: https://github.com/CPS-IT/handlebars/issues |
18 | | - |
19 | | -Also, please check if there is already an issue on the topic you want |
20 | | -to address. |
21 | | - |
22 | | -## Contribution workflow |
23 | | - |
24 | | -**Note: This extension follows [Semantic Versioning](https://semver.org/).** |
25 | | - |
26 | | -### Preparation |
27 | | - |
28 | | -Clone the repository first: |
29 | | - |
30 | | -```bash |
31 | | -git clone https://github.com/CPS-IT/handlebars.git |
32 | | -cd handlebars |
33 | | -``` |
34 | | - |
35 | | -Now install all Composer dependencies: |
36 | | - |
37 | | -```bash |
38 | | -composer install |
39 | | -``` |
40 | | - |
41 | | -### Check code quality |
42 | | - |
43 | | -[](https://github.com/CPS-IT/handlebars/actions/workflows/cgl.yaml) |
44 | | - |
45 | | -```bash |
46 | | -# Run all linters |
47 | | -composer lint |
48 | | - |
49 | | -# Run Composer normalization |
50 | | -composer lint:composer |
51 | | - |
52 | | -# Run PHP linter only |
53 | | -composer lint:php |
54 | | - |
55 | | -# Run TypoScript linter only |
56 | | -composer lint:typoscript |
57 | | - |
58 | | -# Run PHP static code analysis |
59 | | -composer sca |
60 | | -``` |
61 | | - |
62 | | -### Run tests |
63 | | - |
64 | | -[](https://github.com/CPS-IT/handlebars/actions/workflows/tests.yaml) |
65 | | -[](https://codecov.io/gh/CPS-IT/handlebars) |
66 | | - |
67 | | -```bash |
68 | | -# Run tests |
69 | | -composer test |
70 | | - |
71 | | -# Run tests with code coverage |
72 | | -composer test:coverage |
73 | | -``` |
74 | | - |
75 | | -The code coverage reports will be stored in `.Build/log/coverage`. |
76 | | - |
77 | | -### Build documentation |
78 | | - |
79 | | -```bash |
80 | | -# Rebuild and open documentation |
81 | | -composer docs |
82 | | - |
83 | | -# Build documentation (from cache) |
84 | | -composer docs:build |
85 | | - |
86 | | -# Open rendered documentation |
87 | | -composer docs:open |
88 | | -``` |
89 | | - |
90 | | -The built docs will be stored in `.Build/docs`. |
91 | | - |
92 | | -### Pull Request |
93 | | - |
94 | | -When you have finished developing your contribution, simply submit a |
95 | | -pull request on GitHub: https://github.com/CPS-IT/handlebars/pulls |
| 5 | +[1]: https://docs.typo3.org/p/cpsit/typo3-handlebars/main/en-us/Contributing/Index.html |
0 commit comments