Update README.md

This commit is contained in:
Tim Düsterhus 2013-12-02 00:10:51 +01:00
parent 5f52a1018c
commit 37af6104dd
1 changed files with 4 additions and 27 deletions

View File

@ -1,33 +1,10 @@
Tims Chat 3.0
=============
Tims Chat 3.0
==============
Tims Chat is a chat-plugin for WoltLab Community Framework.
Tims Chat is a chat-plugin for WoltLab Community Framework.
Version notes
-------------
The currently available source code represents an early alpha-version of Tims Chat, even though it may be installable, we cannot guarantee a working installation at any time. You MUST NOT install and/or use Tims Chat 3.0 in a production environment.
Contribution
------------
Developers are always welcome to fork Tims Chat and provide features or bug fixes using pull requests. If you make changes or add classes it is mandatory to follow the requirements below:
* Testing is key, you MUST try out your changes before submitting pull requests
* You MUST save your files with Unix-style line endings (\n)
* You MUST NOT include the closing tag of a PHP block at the end of file, provide an empty newline instead
* You MUST use tabs for indentation
* Tab size of 8 is required
* Empty lines MUST be indented equal to previous line
* All comments within source code MUST be written in English language
* Use a sensible number of commits. In most cases one commit should be enough.
* Split huge changes into several logical groups
* Rebase small changes that consist of several commits into one commit
Follow the above conventions if you want your pull requests accepted.
License
-------
For licensing information refer to the LICENSE file in this folder.
For licensing information refer to the LICENSE file in this folder.