Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

78 lines (47 loc) · 2.82 KB

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.

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

Vision

The general idea of this project is described in the README.

How to contribute

There are many ways to contribute to Open Source projects 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.

Opening a pull request

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

Please explain your changes in a short, readable commit message.

Coding Guidelines

This project has adopted the PSR-2 Coding Style Guide for PHP Code.

General file formats are defined in the EditorConfig.

The project follows the naming scheme of the Flow Framework 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.

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.

Feedback

Everything in open source should be a series of kindnesses.

Please send some feedback and share how this package has proven useful to you and how you may help to improve it.