Skip to content

Commit 76e09a9

Browse files
committed
Merge pull request joomla#45 from Hutchy68/gh-pages
Simplifying the page
2 parents 52a3c27 + c68b864 commit 76e09a9

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

manual/en-US/coding-standards/chapters/source-code-management.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,23 @@
22

33
Before we start talking about what code should look like, it is appropriate to look at how and where the source code is stored. All serious software projects, whether driven by an Open Source community or developed within a company for proprietary purposes will manage the source code is some sort of source or version management system.
44

5-
## The Joomla Platform
5+
## The Joomla Framework
66

7-
In April 2011 the Joomla project decided to formally split off the core engine that drives the Joomla CMS into a separate project with a separate development path called the Joomla Platform. The Joomla Platform is a PHP framework that is designed to serve as a foundation for not only web applications (like a CMS) but other types of software such as command line applications. The files that form the Joomla Platform are stored in a Distributed Version Control System (DVCS) called Git hosted at github.com
7+
The [Joomla Framework](https://github.com/joomla/joomla-framework) is a PHP framework that is designed to serve as a foundation for not only web applications (like a CMS) but other types of software such as command line applications. The files that form the Joomla Framework are stored in a Distributed Version Control System (DVCS) called Git hosted at github.com
88

9-
You can learn about how to get the Joomla Platform source code from the Git repository from the following page: `@todo` permalink to developer.joomla.org staging page
9+
You can learn about how to get the Joomla Framework source code from the Git repository, https://github.com/joomla/joomla-framework.
10+
11+
Because Git treats the concepts of file revision numbers differently than Subversion, the repository revision number is not required in files (that is, the `@version` tag is not necessary).
12+
13+
## The Joomla CMS
14+
The [Joomla! CMS](https://github.com/joomla/joomla-cms) is a Content Management System (CMS) which enables you to build Web sites and powerful online applications. It's a free and OpenSource software, distributed under the GNU General Public License version 2 or later. The files that form the Joomla CMS are stored in a Distributed Version Control System (DVCS) called Git hosted at github.com
15+
16+
You can learn about how to get the Joomla CMS source code from the Git repository, https://github.com/joomla/joomla-cms.
1017

1118
Because Git treats the concepts of file revision numbers differently than Subversion, the repository revision number is not required in files (that is, the `@version` tag is not necessary).
1219

1320
## Compliance Tool
1421

15-
The standards in this manual have been adopted across the Joomla project, including the Joomla Platform, the Joomla CMS and any other applications maintained by the project. These standards apply to source code, tests and (where applicable) documentation.
22+
The standards in this manual have been adopted across the Joomla project, including the [Joomla Framework](https://github.com/joomla/joomla-framework), the [Joomla! CMS](https://github.com/joomla/joomla-cms) and any other applications maintained by the project. These standards apply to source code, tests and (where applicable) documentation.
1623

1724
A custom Joomla sniff standard for PHP files is maintained by the Joomla project and available from the code repository. The Sniff is based on the standard outlined in this document. For more information about how code standards are enforced see the analysis appendix of the manual. For information on using the Sniff see the documentation stored in its repository.

manual/en-US/coding-standards/preface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
One of the things that sets good software apart from great software is not the features or the actual function the software performs, but the quality of the source code. In order to perform in the highly competitive Open Source and proprietary software industries, the source code not only needs to be beautifully designed, it also needs to be beautiful and elegant to look at.
44

5-
Readable code is maintainable code and the compass that guides us in achieving that goal is a set of well thought out coding standards for the different software languages that are employed in our software project. Joomla has a solid heritage of striving to support a great looking product with great looking code. This document compiles the collective wisdom of past and present contributors to the project to form the definitive standard for coding in Joomla, whether that is for the core Joomla Platform or an extension that forms part of the stack of the Joomla CMS. It also serves as a lighthouse to the Joomla developer community, to safely guide developers around the pitfalls of becoming lackadaisical with respect to writing clean, beautiful code.
5+
Readable code is maintainable code and the compass that guides us in achieving that goal is a set of well thought out coding standards for the different software languages that are employed in our software project. Joomla has a solid heritage of striving to support a great looking product with great looking code. This document compiles the collective wisdom of past and present contributors to the project to form the definitive standard for coding in Joomla, whether that is for the core Joomla Framework or an extension that forms part of the stack of the Joomla CMS. It also serves as a lighthouse to the Joomla developer community, to safely guide developers around the pitfalls of becoming lackadaisical with respect to writing clean, beautiful code.
66

77
The Joomla Coding Standards borrows heavily from the PEAR coding standard for PHP files, augmenting and diverging where it is deemed sensible to do so.

0 commit comments

Comments
 (0)