Commit 0745e778 authored by Christian Kuhn's avatar Christian Kuhn Committed by Markus Klein
Browse files

[TASK] Improve README.md, add CONTRIBUTING.md

Streamline README.md a bit and add a CONTRIBUTING.md
to hint for basic contribution guidelines.
The CONTRIBUTING.md is especially helpful if the GitHub
repository is forked since GitHub will add a notice with
a link to this file.

Change-Id: I2ff78f72346da4146f6d68777f263d34e0a30a7f
Resolves: #68447
Releases: master
Reviewed-on: http://review.typo3.org/41791

Reviewed-by: default avatarHelmut Hummel <helmut.hummel@typo3.org>
Tested-by: default avatarHelmut Hummel <helmut.hummel@typo3.org>
Reviewed-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
parent 1df277a7
Contributing
------------
TYPO3 CMS core is a volunteer effort. We encourage you to join the project by submitting changes.
Have a look at our [detailed contribution walkthrough][1].
If you like to contribute code, please use the [main git repository][2], all changes are
processed in our [review system][3]. The [GitHub repository][4] is a synchronized
mirror of the primary git repository and pull requests via GitHub are not supported at the moment.
If you like to contribute to our [documentation][5], use the "Edit me on GitHub" button
in the top right of each manual or reference or just make a pull request in any of the repositories
that can be found in the TYPO3 [documentation team GitHub organisation][6].
[1]: https://wiki.typo3.org/Contribution_Walkthrough_Tutorials
[2]: https://git.typo3.org/Packages/TYPO3.CMS.git
[3]: https://review.typo3.org/#/q/project:Packages/TYPO3.CMS,n,z
[4]: https://github.com/TYPO3/TYPO3.CMS
[5]: http://docs.typo3.org/typo3cms/
[6]: https://github.com/TYPO3-Documentation
\ No newline at end of file
......@@ -47,7 +47,7 @@ TYPO3 System requirements
-----------------------------
TYPO3 is based upon PHP and uses a MySQL database. For more information
regarding these requirements see the INSTALL.md file in this folder.
regarding these requirements see the [INSTALL.md](INSTALL.md) file in this folder.
Using the Database Abstraction Layer (DBAL) allows one to use TYPO3 with other
Database Management Systems, like PostgreSQL, Oracle and MSSQL.
......@@ -58,25 +58,16 @@ TYPO3 resources
Here is an overview of the most important TYPO3 resources to help you get
started:
### Text files bundled in this package
* README.md: This file, provides a basic overview on the product and
points to important resources.
* INSTALL.md: System requirements to install and use TYPO3, the basic
installation instructions and information about upgrading an existing
installation to the new version.
### Get more information
* http://typo3.org is the main project website. It provides up to
* https://typo3.org is the main project website. It provides up to
date official news, information about events, access to downloading the
products and extensions.
* http://wiki.typo3.org is a collaborative wiki, providing access to
* https://wiki.typo3.org is a collaborative wiki, providing access to
all kind of information around the TYPO3 ecosphere.
* http://www.typo3.org/documentation: TYPO3 is one of the most thoroughly
* http://docs.typo3.org/: TYPO3 is one of the most thoroughly
documented OpenSource products around, with manuals covering basic
tutorials, TypoScript, administration, development, core structure, etc.
You should make the time to locate the various documents, and read those
......@@ -98,21 +89,28 @@ The community and all TYPO3 teams communicate through newsgroups, which can
also be accessed through mailing lists and forums. Any of these three ways
provide access to the same communication channels:
* Forum (Web): http://forum.typo3.org/
* Mailing Lists (Mail): http://typo3.org/support/mailing-lists/
* Forum (Web): https://forum.typo3.org/
* Mailing Lists (Mail): https://typo3.org/support/mailing-lists/
* Newsgroups (NNTP): news://lists.typo3.org/
### Participate in the development
Contributing
------------
If you want to file a bug report, maintain your own extension using our
infrastructure (Git, Issue Tracker, Wiki, etc), take a look at:
If you want to contribute to the TYPO3 CMS source code, take a look at our
Contributors Walkthrough and Review System:
* http://forge.typo3.org
* https://wiki.typo3.org/CWT
* https://review.typo3.org/
If you want to contribute to the TYPO3 CMS source code, take a look at our
Contributors Walkthrough:
The [repository at GitHub](https://github.com/TYPO3/TYPO3.CMS) is a
synchronized mirror of the primary TYPO3 CMS core git repository:
* https://git.typo3.org/Packages/TYPO3.CMS.git
If you want to file a bug report, maintain your own extension using our
infrastructure (Git, Issue Tracker, Wiki, etc), take a look at:
* http://wiki.typo3.org/CWT
* https://forge.typo3.org
Final notes
-----------
......@@ -137,9 +135,9 @@ The decisions will be made transparent to the community and especially the
supporting members. Your funds will also serve for other purposes as laid
out in the bylaws.
* Donate: http://typo3.org/donate
* Donate: https://typo3.org/donate
* Become a member of the TYPO3 Association:
http://association.typo3.org/association/join-now/
https://typo3.org/association/membership/levels/
Copyleft
--------
......
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