GitLab Commit is coming up on August 3-4. Learn how to innovate together using GitLab, the DevOps platform. Register for free: gitlabcommitvirtual2021.com

Commit 886cda7d authored by Dan Untenzu's avatar Dan Untenzu 馃樂
Browse files

[FEATURE] 馃摑 Add feedback loop to Readme

parent 2c5716f5
# Contributing
Thank you for your proposed contribution! This guide will help you along.
馃敯 Thank you for your proposed contribution! This guide will help you along.
## Code of Conduct
......@@ -14,24 +14,65 @@ 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/de/how-to-contribute/)
beyond coding.
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
## 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.
- [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)
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/).
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 `development` until a new version is released.
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.
......@@ -6,11 +6,13 @@
[![License](https://img.shields.io/badge/license-gpl--2.0--or--later-blue.svg?style=flat-square)](https://spdx.org/licenses/GPL-2.0-or-later.html)
[![Contribution](https://img.shields.io/badge/contributions_welcome-%F0%9F%94%B0-brightgreen.svg?labelColor=brightgreen&style=flat-square)](https://gitlab.com/pixelbrackets/html5-mini-template/-/blob/master/CONTRIBUTING.md)
The packages provides an HTML5 mini template for quick rendering of
status pages, TOC pages, or any other minimal single-serving site.
HTML5 Mini Template for quick rendering of status pages, TOC pages,
or any other minimal single-serving site.
![Screenshot](./docs/screenshot.png)
_猸 You like this package? Please star it or send a tweet. 猸恄
## Vision
This package provides a single class to turn a message or HTML-snippet into
......@@ -42,7 +44,7 @@ to pass a custom title.
## Requirements
* PHP
- PHP
## Installation
......@@ -52,7 +54,8 @@ Packagist Entry https://packagist.org/packages/pixelbrackets/html5-mini-template
https://gitlab.com/pixelbrackets/html5-mini-template/
Mirror https://github.com/pixelbrackets/html5-mini-template
Mirror https://github.com/pixelbrackets/html5-mini-template/ (Issues & Pull Requests
mirrored to GitLab)
## Demo
......@@ -131,10 +134,15 @@ Dan Untenzu (<mail@pixelbrackets.de> / [@pixelbrackets](https://pixelbrackets.de
## Changelog
See [./CHANGELOG.md](CHANGELOG.md)
See [CHANGELOG.md](./CHANGELOG.md)
## Contribution
This script is Open Source, so please use, patch, extend or fork it.
This script is Open Source, so please use, share, patch, extend or fork it.
[Contributions](./CONTRIBUTING.md) are welcome!
## Feedback
[Contributions](CONTRIBUTING.md) are welcome!
Please send some [feedback](https://pixelbrackets.de/) and share how this
package has proven useful to you or how you may help to improve it.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment