Skip to content

Commit bbc7178

Browse files
chore: add contributing guidelines to improve collaboration
1 parent 20110f3 commit bbc7178

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing
2+
3+
Thank you for considering contributing to this project! Every contribution is welcome and helps improve the quality of the project. To ensure a smooth process and maintain high code quality, please follow the steps below.
4+
5+
## Requirements
6+
7+
- [DDEV](https://ddev.readthedocs.io/en/stable/)
8+
9+
## Preparation
10+
11+
```bash
12+
# Clone repository
13+
git clone https://github.com/xima-media/xima-typo3-internal-news.git
14+
cd xima-typo3-internal-news
15+
16+
# Start the project with DDEV
17+
ddev start
18+
19+
# Install dependencies
20+
ddev composer install
21+
```
22+
23+
## Run linters
24+
25+
```bash
26+
# All linters
27+
ddev composer lint
28+
29+
# Specific linters
30+
ddev composer lint:composer
31+
ddev composer lint:editorconfig
32+
ddev composer lint:language
33+
ddev composer lint:php
34+
ddev composer lint:typoscript
35+
ddev composer lint:yaml
36+
37+
# Fix all CGL issues
38+
ddev composer fix
39+
40+
# Fix specific CGL issues
41+
ddev composer fix:composer
42+
ddev composer fix:editorconfig
43+
ddev composer fix:php
44+
```
45+
46+
## Run static code analysis
47+
48+
```bash
49+
# All static code analyzers
50+
ddev composer sca
51+
52+
# Specific static code analyzers
53+
ddev composer sca:php
54+
```
55+
56+
## TYPO3 Setup
57+
58+
For testing the extension, you need to set up the TYPO3 instances.
59+
60+
```bash
61+
# Install all TYPO3 versions, which are supported by the extension
62+
ddev install all
63+
64+
# Or install specific TYPO3 versions
65+
ddev install 12
66+
ddev install 13
67+
68+
# Open the overview page
69+
ddev launch
70+
71+
# Run TYPO3 specific commands
72+
ddev 12 typo3 cache:flush
73+
ddev 13 composer install
74+
ddev all typo3 database:updateschema
75+
```
76+
77+
## Submit a pull request
78+
79+
After completing your work, **open a pull request** and provide a description of your changes. Ideally, your PR should reference an issue that explains the problem you are addressing.
80+
81+
All mentioned code quality tools will run automatically on every pull request. For more details, see the relevant [workflows][1].
82+
83+
[1]: .github/workflows

0 commit comments

Comments
 (0)