README.md

   1 WoltLab Community Framework 2.0
   2 ===============================
   3
   4 WoltLab Community Framework is a free web-framework, designed and developed for complex community applications. The framework uses the latest and most modern technologies, is structured completly object-oriented, constantly enhanced and the base for all WoltLab products.
   5
   6 Version notes
   7 -------------
   8
   9 The currently available source code represents an early alpha-version of WCF, even though it may be installable, we cannot guarantee a working installation at any time. You MUST NOT install and/or use WCF 2.0 in a production environment.
  10
  11 **COMPLETE FEATURE FREEZE**
  12 New pull requests or suggestions will be denied (or delayed until WCF 2.1); API changes are no longer allowed unless they solve an already existing issue.
  13 This applies to all packages belonging to Community Framework.
  14
  15 Contribution
  16 ------------
  17
  18 Developers are always welcome to fork WCF and provide features or bug fixes using pull requests. If you make changes or add classes it is mandatory to follow the requirements below:
  19
  20 * Testing is key, you MUST try out your changes before submitting pull requests
  21 * You MUST save your files with Unix-style line endings (\n)
  22 * You MUST NOT include the closing tag of a PHP block at the end of file, provide an empty newline instead
  23 * You MUST use tabs for indentation
  24     * Tab size of 8 is required
  25     * Empty lines MUST be indented equal to previous line
  26 * All comments within source code MUST be written in English language
  27
  28 Follow the above conventions if you want your pull requests accepted.
  29
  30 License
  31 -------
  32
  33 This library is free software; you can redistribute it and/or
  34 modify it under the terms of the GNU Lesser General Public License
  35 as published by the Free Software Foundation; either version 2.1
  36 of the License, or (at your option) any later version.
  37
  38 This library is distributed in the hope that it will be useful,
  39 but WITHOUT ANY WARRANTY; without even the implied warranty of
  40 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  41 Lesser General Public License for more details.
  42
  43 You should have received a copy of the GNU Lesser General Public
  44 License along with this library; if not, write to the Free Software
  45 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA