CONTRIBUTING.md 2.82 KB
Newer Older
Dan Untenzu's avatar
Dan Untenzu committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Contributing

🔰 Thank you for your proposed contribution! This guide will help you along.

## Code of Conduct

This project has adopted the [TYPO3 Code of Conduct](https://typo3.org/community/values/code-of-conduct/).

By participating in this project you agree to abide by its terms.

## Vision

The general idea of this project is described in the [README](./README.md#Vision).

## How to contribute

There are many ways to [contribute to Open Source projects](https://opensource.guide/how-to-contribute/)
beyond coding. Draft a new design, test features and give feedback, report bugs,
improve the documentation, review the issue tracker and suggest closing
duplicates or outdated tickets. Spread the word and write a tweet or blog post.

You like to code? Find an open issue and fix a bug. Add tests or improve the
project setup. Or build a new feature.

## Workspace

🚧 This project is maintained on GitLab.

It is mirrored to GitHub though. If you feel more comfortable with GitHub,
then you are able to work with this mirror just fine.
All issues and pull requests are mirrored to GitLab.

## Opening a ticket

Please always open a ticket or comment on existing issues before you start
working on something.

- [Guide to open a ticket](https://opensource.guide/how-to-contribute/#opening-an-issue)

## Opening a pull request

- [Guide to open a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request)
- [Guide to update a pull request](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)

Keep your pull requests limited to a single issue. One feature branch per issue.

Please explain your changes in a short,
[readable commit message](https://pixelbrackets.de/notes/commit-message-format).

## Coding Guidelines

This project has adopted the
[PSR-2 Coding Style Guide](https://www.php-fig.org/psr/psr-2/) for PHP Code.

General file formats are defined in the [EditorConfig](https://editorconfig.org/).

The project follows the naming scheme of the
[Flow Framework](https://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartV/CodingGuideLines/PHP.html#naming)
for classes, methods, variables and filenames.

✅ Don't worry. The guidlines are checked automatically in every pull request.

## Release cycle

This project has adopted [SemVer 2 Versioning](https://semver.org/).

New commits are composed in branch `development` until a new version is 
released.

All notable changes made between each release are documented in the
[Changelog](./CHANGELOG.md).

## Feedback

[Everything in open source should be a series of kindnesses](https://snarky.ca/setting-expectations-for-open-source-participation/#everythinginopensourceshouldbeaseriesofkindnesses).

Please send some [feedback](https://pixelbrackets.de/) and share how this
package has proven useful to you and how you may help to improve it.