Skip to content

Commit 51daa5d

Browse files
committed
Add prettier and fix stylelint upgrade
1 parent 1b61070 commit 51daa5d

File tree

146 files changed

+23276
-22641
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+23276
-22641
lines changed

.dkim/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ This private key must never be added to the git-history! Ask a product owner in
55

66
The corresponding public key must be added to the DNS Dkim entry (Cloudflare).
77

8-
Note: The private key must be kept valid during deployments.
8+
Note: The private key must be kept valid during deployments.

.eslintrc.yaml

+7-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ globals:
1010
SharedArrayBuffer: readonly
1111
parserOptions:
1212
ecmaVersion: 2018
13-
rules: {
14-
"no-new": 0,
15-
}
13+
rules:
14+
{
15+
'no-new': 0,
16+
'comma-dangle': 0,
17+
'space-before-function-paren': 0,
18+
'indent': 0,
19+
}
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: 'Install node and npm modules'
22
description: 'Install node and npm modules. Caching is enabled for enhanced performance.'
33
runs:
4-
using: "composite"
4+
using: 'composite'
55
steps:
6-
- name: "Download and set up node (caching is enabled)"
6+
- name: 'Download and set up node (caching is enabled)'
77
uses: actions/setup-node@v3
88
with:
99
node-version: '20.x'
1010

11-
- name: "Use caching action to improve performance"
11+
- name: 'Use caching action to improve performance'
1212
id: npm-cache
1313
uses: actions/cache@v3
1414
with:
@@ -17,7 +17,7 @@ runs:
1717
restore-keys: |
1818
${{ runner.os }}-node-
1919
20-
- name: "Only install modules if there is no cache hit"
20+
- name: 'Only install modules if there is no cache hit'
2121
# "If" not yet supported: https://github.com/actions/runner/issues/834 -> shell workaround
2222
# - if: steps.npm-cache.outputs.cache-hit != 'true'
2323
# run: npm ci
@@ -28,4 +28,4 @@ runs:
2828
echo "Cache hit - skipping dependency installation"
2929
else
3030
npm ci
31-
fi
31+
fi

.github/actions/setup-php-composer/action.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
name: 'Install php and composer vendor libraries'
22
description: 'Install php and composer vendor libraries. Caching is enabled for enhanced performance.'
33
runs:
4-
using: "composite"
4+
using: 'composite'
55
steps:
6-
- name: "Setup PHP 8.2"
6+
- name: 'Setup PHP 8.2'
77
uses: shivammathur/setup-php@v2
88
with:
99
php-version: 8.2
1010

11-
- name: "Ensure composer configuration is valid"
11+
- name: 'Ensure composer configuration is valid'
1212
shell: bash
1313
run: composer validate
1414

15-
- name: "Use caching action to improve performance"
15+
- name: 'Use caching action to improve performance'
1616
id: composer-cache
1717
uses: actions/cache@v3
1818
with:
@@ -29,7 +29,7 @@ runs:
2929
restore-keys: |
3030
${{ runner.os }}-php--
3131
32-
- name: "Only install packages if there is no cache hit"
32+
- name: 'Only install packages if there is no cache hit'
3333
# "If" not yet supported: https://github.com/actions/runner/issues/834 -> shell workaround
3434
# - if: steps.composer-cache.outputs.cache-hit != 'true'
3535
# run: composer install --prefer-dist --no-progress
@@ -40,4 +40,4 @@ runs:
4040
echo "Cache hit - skipping dependency installation"
4141
else
4242
composer install --prefer-dist --no-progress
43-
fi
43+
fi

.github/codecov.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ coverage:
3232
# it is only QOL change and not required
3333
#
3434
comment:
35-
after_n_builds: 29
35+
after_n_builds: 29

.github/contributing.md

+38-26
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Contributing to Catroweb
2+
23
:tada: Firstly, thank you for contributing to Catroweb! You are one of the pandas now! :tada:
34

4-
**PR's** are always appreciated! Please be sure to fill out the
5-
[PR Template](https://github.com/Catrobat/Catroweb-Symfony/blob/develop/.github/pull_request_template.md)
5+
**PR's** are always appreciated! Please be sure to fill out the
6+
[PR Template](https://github.com/Catrobat/Catroweb-Symfony/blob/develop/.github/pull_request_template.md)
67
as detailed as possible. You will be the hero of everyone who does code reviews. Every pull request will be automatically
78
checked against various tests in our GitHub Actions CI system. Make sure all tests are passing!
8-
When tests are failing the PR will not be accepted.
9+
When tests are failing the PR will not be accepted.
910

1011
### Guides
12+
1113
There are comprehensive Guides and Cheat Sheets available in our [wiki](https://github.com/Catrobat/Catroweb-Symfony/wiki/).
1214
Make sure to check them out if you have any questions, before asking a project maintainer.
1315

@@ -18,30 +20,39 @@ Make sure to check them out if you have any questions, before asking a project m
1820
3. Implement your logic
1921
4. Check that all tests pass
2022
5. Repeat 1-4 if necessary
23+
2124
##### 6. Create a Pull Request:
2225

23-
Also, make sure that every commit has the **correct commit message layout** so it shows up on [JIRA](https://jira.catrob.at/).<br/>
24-
must read: [How to Write a Git Commit Message, by Chirs Beams](http://chris.beams.io/posts/git-commit/)
25-
```
26-
Line 1: SHARE-XXX Fitting Title (< 50 chars)
27-
Line 2: empty line
28-
Lines 3 - X: actual commit message; first focusing on WHY then focusing on WHAT you have changed.
29-
```
26+
Also, make sure that every commit has the **correct commit message layout** so it shows up on [JIRA](https://jira.catrob.at/).<br/>
27+
must read: [How to Write a Git Commit Message, by Chirs Beams](http://chris.beams.io/posts/git-commit/)
28+
29+
```
30+
Line 1: SHARE-XXX Fitting Title (< 50 chars)
31+
Line 2: empty line
32+
Lines 3 - X: actual commit message; first focusing on WHY then focusing on WHAT you have changed.
33+
```
34+
3035
Squash your commits, there must be only 1 commit! (XX is the number of your commits)
31-
```
32-
git reset --soft HEAD~XX &&
33-
git commit
34-
```
35-
When there is only one commit and you just need to change the commit message you can use:
36-
```
37-
git commit --amend
38-
```
39-
Go to GitHub and **create a Pull-Request** from your forked repository into the official repository.<br/>
40-
- check that you create the PR from your correct ticket branch!
41-
- check that PR goes to the `develop` branch and not `master` branch!
42-
- enable "allow edits from maintainers", this allows the Seniors to rebase your PR if needed
36+
37+
```
38+
git reset --soft HEAD~XX &&
39+
git commit
40+
```
41+
42+
When there is only one commit and you just need to change the commit message you can use:
43+
44+
```
45+
git commit --amend
46+
```
47+
48+
Go to GitHub and **create a Pull-Request** from your forked repository into the official repository.<br/>
49+
50+
- check that you create the PR from your correct ticket branch!
51+
- check that PR goes to the `develop` branch and not `master` branch!
52+
- enable "allow edits from maintainers", this allows the Seniors to rebase your PR if needed
4353

4454
##### 7. Keep your PR up-to-date and be responsive to requested changes. Make sure the CI tests pass
55+
4556
- **merge-conflicts?** Resolve them and rebase your PR.<br/>
4657

4758
```
@@ -50,15 +61,16 @@ Squash your commits, there must be only 1 commit! (XX is the number of your comm
5061
git checkout SHARE-XX
5162
git rebase -i develop
5263
```
64+
5365
Resolve conflicts if necessary (Note: IDE's like Phpstorm have great tools to resolve such conflicts).
66+
5467
```
5568
git rebase --continue
5669
git push -f
5770
```
5871

59-
- **requested changes?**
72+
- **requested changes?**
6073

61-
Feel free to discuss them with your code reviewer before blindly accepting them.
62-
Then if necessary apply the changes.
74+
Feel free to discuss them with your code reviewer before blindly accepting them.
75+
Then if necessary apply the changes.
6376
After resolving the changes, don't forget to squash your commits and force push the branch.
64-

.github/dependabot.yaml

+36-37
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,42 @@
99
#
1010
version: 2
1111
updates:
12+
- package-ecosystem: 'docker'
13+
directory: '/docker'
14+
schedule:
15+
interval: daily
16+
time: '04:00'
17+
timezone: 'Europe/Vienna'
18+
reviewers:
19+
- 'dmetzner'
20+
open-pull-requests-limit: 99
1221

13-
- package-ecosystem: "docker"
14-
directory: "/docker"
15-
schedule:
16-
interval: daily
17-
time: "04:00"
18-
timezone: "Europe/Vienna"
19-
reviewers:
20-
- "dmetzner"
21-
open-pull-requests-limit: 99
22+
- package-ecosystem: 'npm'
23+
directory: '/'
24+
schedule:
25+
interval: daily
26+
time: '04:00'
27+
timezone: 'Europe/Vienna'
28+
reviewers:
29+
- 'dmetzner'
30+
open-pull-requests-limit: 99
2231

23-
- package-ecosystem: "npm"
24-
directory: "/"
25-
schedule:
26-
interval: daily
27-
time: "04:00"
28-
timezone: "Europe/Vienna"
29-
reviewers:
30-
- "dmetzner"
31-
open-pull-requests-limit: 99
32+
- package-ecosystem: 'composer'
33+
directory: '/'
34+
schedule:
35+
interval: daily
36+
time: '04:00'
37+
timezone: 'Europe/Vienna'
38+
reviewers:
39+
- 'dmetzner'
40+
open-pull-requests-limit: 99
3241

33-
- package-ecosystem: "composer"
34-
directory: "/"
35-
schedule:
36-
interval: daily
37-
time: "04:00"
38-
timezone: "Europe/Vienna"
39-
reviewers:
40-
- "dmetzner"
41-
open-pull-requests-limit: 99
42-
43-
- package-ecosystem: "github-actions"
44-
directory: "/"
45-
schedule:
46-
interval: daily
47-
time: "04:00"
48-
timezone: "Europe/Vienna"
49-
reviewers:
50-
- "dmetzner"
51-
open-pull-requests-limit: 99
42+
- package-ecosystem: 'github-actions'
43+
directory: '/'
44+
schedule:
45+
interval: daily
46+
time: '04:00'
47+
timezone: 'Europe/Vienna'
48+
reviewers:
49+
- 'dmetzner'
50+
open-pull-requests-limit: 99

.github/onboarding.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,58 @@
11
This step-by-step guide will support you on your way to your first pull request (PR) at Catrobat. To achieve this, we will guide you through the following steps:
2+
23
1. Workspace Setup
34
2. Finding your first Ticket
45
3. Implementing your first ticket using Catrobat's Contribution Workflow
56

67
# 1. Workspace Setup
7-
First, we will show you how to set up your working environment and verify the correctness of this setup.
88

9+
First, we will show you how to set up your working environment and verify the correctness of this setup.
910

1011
## a. Installing the IDE and Tools
11-
We recommend using [PhpStorm](https://www.jetbrains.com/phpstorm/) as all our contributors do. Please find the IDE version suitable for your operating system on the website and install it on your computer.
1212

13+
We recommend using [PhpStorm](https://www.jetbrains.com/phpstorm/) as all our contributors do. Please find the IDE version suitable for your operating system on the website and install it on your computer.
1314

1415
## b. Repository Setup
16+
1517
### (I) Git Setup
18+
1619
At Catrobat, we use Git to keep track of changes in our codebase. If you have not installed Git on your computer yet, please follow the [official guide to set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git).
1720

1821
### (II) Catrobat's Forking Workflow
22+
1923
To enable the contribution of people like you, we decided to use a forking workflow. In a nutshell, this works as follows. First, everyone who wants to contribute creates (=forks) a personal copy of our repository (=fork). The contributor then makes changes on his fork and informs the community about the changes via a PR. A core contributor will review the changes in the PR. If the changes are accepted, the core contributor will merge the changes into the original repository of Catrobat.
2024
If you are unfamiliar with Git or have not used it recently, the official guide about [forking a repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) is a good starting point.
2125

2226
### (III) Setting up your Fork
27+
2328
Now that you know how to work with Git, it is time to set up your fork by executing the following steps. We recommend to use Docker for an easy and seamless setup process:
29+
2430
- [Install Docker](https://github.com/Catrobat/Catroweb/wiki/Docker#install-docker)
2531
- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the [repository of Catroweb](https://github.com/Catrobat/Catroweb)
2632
- [Clone](https://github.com/Catrobat/Catroweb/wiki/Docker#checkout-the-catroweb-project) the repository
2733

2834
You can find more information about using Catroweb with Docker [here](https://github.com/Catrobat/Catroweb/wiki/Docker#introduction-to-catroweb-with-docker).
2935

30-
3136
## c. Setup Verification
37+
3238
Now you should be able to [run Catroweb in Docker](https://github.com/Catrobat/Catroweb/wiki/Docker#running-catroweb-dev-in-docker) to display the sharing platform similar to our [current version online](https://share.catrob.at/app/).
3339

3440
Note: Make sure that you run the commands through [Git Bash in PhpStorm](https://medium.com/code-complete/using-git-bash-with-phpstorm-10f8d54a96da).
3541

36-
37-
3842
# 2. Finding your first Ticket
3943

40-
4144
## a. Catrobat's Jira Workflow
45+
4246
At Catrobat, we use Jira to keep track of all issues (stories, tasks, and bugs) in our projects. You can find the Jira project of Catroweb [here](https://jira.catrob.at/projects/SHARE/issues/SHARE-527?filter=allopenissues).
4347
If you click "Kanban Board" on the left menu in Jira, you will get an overview of what we are currently working on. You can see that different issues have different statuses (e.g., "Ready for Development"). The collection of all statuses makes up our Jira workflow that transparently shows the project's current state to every team member. You can find an overview of our Jira workflow if you click on an issue and the "(View Workflow)" next to the status field.
4448
It is crucial to follow this workflow to keep the team informed about what you are currently working on.
4549

46-
4750
## b. Choosing a suitable Ticket
48-
We prepared a [beginner ticket](https://jira.catrob.at/browse/SHARE-532) for our newcomers that should be easy to implement. You will find all the necessary information in the ticket.
4951

52+
We prepared a [beginner ticket](https://jira.catrob.at/browse/SHARE-532) for our newcomers that should be easy to implement. You will find all the necessary information in the ticket.
5053

5154
## c. Informing the Community
55+
5256
As mentioned earlier, it is essential to keep the team updated. As you do not have the permissions for our Jira project yet, you cannot change the status of the issue you chose. Instead, please assign the ticket to yourself by commenting on it using the following template.
5357

5458
```diff
@@ -63,10 +67,10 @@ After you have finished your work and submitted a pull request, you have to use
6367

6468
💡 In the upcoming steps, you will find the general workflow of the project. As you do not have permissions for Jira and Confluence yet, please skip all actions that involve Jira ticket status updates and additional information on Confluence!
6569

66-
67-
6870
# 3. Catrobat's Contribution Workflow
71+
6972
The general workflow of the project involves the following steps:
73+
7074
- Claim a Ticket
7175
- Do the Work
7276
- Submit the Changes

.github/pull_request_template.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
---
2+
23
### Your checklist for this pull request
4+
35
Please review the [contributing guidelines](https://github.com/Catrobat/Catroweb-Symfony/blob/develop/.github/contributing.md) and [wiki pages](https://github.com/Catrobat/catroweb-Symfony/wiki/) of this repository.
46

57
- [ ] Include the name and id of the Jira ticket in the PR’s title eg.: `SHARE-666 The devils ticket`
6-
- [ ] Choose the proper base branch (*develop*)
8+
- [ ] Choose the proper base branch (_develop_)
79
- [ ] Confirm that the changes follow the project’s coding guidelines
8-
- [ ] Verify that the changes generate no warnings and errors
10+
- [ ] Verify that the changes generate no warnings and errors
911
- [ ] Verify to commit no other files than the intentionally changed ones
1012
- [ ] Include reasonable and readable tests verifying the added or changed behavior
1113
- [ ] Verify that all tests are passing (CI), if not please state the test cases in the [section](#Tests) below
1214
- [ ] Perform a self-review of the changes
1315
- [ ] Stick to the project’s git workflow (rebase and squash your commits)
1416
- [ ] Verify that your changes do not have any conflicts with the base branch
1517
- [ ] Put your ticket into the `Code Review` section in [Jira](https://jira.catrob.at/)
16-
- [ ] Post a message in the *#catroweb* [Slack channel](https://catrobat.slack.com) and ask for a code reviewer
18+
- [ ] Post a message in the _#catroweb_ [Slack channel](https://catrobat.slack.com) and ask for a code reviewer
1719
- [ ] Check that your pull request has been successfully deployed to https://web-test-1.catrob.at/
1820

1921
### Additional Description
22+
2023
`TODO: Add additional information that is not in your commit-message here`
2124

2225
### Tests - additional information
26+
2327
`TODO: add additional information about testruns here`

0 commit comments

Comments
 (0)