Author: qmathe
Date: Wed May 7 17:50:44 2014
New Revision: 10670
URL: http://svn.gna.org/viewcvs/etoile?rev=10670&view=rev
Log:
Removed ChangeLog mentions in the coding style.
And updated Project hierarchy style section (to reflect what we do currently).
Modified:
web/dev/codingstyle/main.html
Modified: web/dev/codingstyle/main.html
URL:
http://svn.gna.org/viewcvs/etoile/web/dev/codingstyle/main.html?rev=10670&r1=10669&r2=10670&view=diff
==============================================================================
--- web/dev/codingstyle/main.html (original)
+++ web/dev/codingstyle/main.html Wed May 7 17:50:44 2014
@@ -13,7 +13,7 @@
Always encode text in UTF-8, except with 'strings' files which should be
encoded in UTF-16.
-Use a 80 characters wide wrapping within source code or raw text files. You
can rely on automatic wrapping for end user documentation stored in the
repository or elsewhere.
+Use a 80 characters wide wrapping within source code or raw text files such as
README or INSTALL. You can rely on automatic wrapping for end user
documentation stored in the repository or elsewhere.
## Terminology Style
@@ -25,61 +25,39 @@
## Project Hierarchy Style
-A project is usually separated in several parts like below:
-
-* _Headers_ directory
+A project is usually separated in several directories:
+
+* one or more directories that group related source code
* headers files
-* _Source_ directory
- * GNUmakefile
- * source code files
-* _Resources_ directory (optional)
+ * implementation files
+* _Tests_ directory (optional, contains the test suite)
+ * headers files
+ * implementation files
+* _English.lproj_ directory (and other localization directories)
* image files
* nib or gorm files
* plist files
* etc.
-* ChangeLog
-* INSTALL
-* README
+* _Documentation_ directory (optional, can be created by documentation.make
automatically)
+* _Examples_ directory (optional)
+* README.md
+* INSTALL.md (or both INSTALL.GNUstep.md and INSTALL.Cocoa.md)
+* NEWS.md
+* TODO.md
* COPYING (or LICENSE)
* GNUmakefile
-When the project is fairly small (few headers and source code files), you can
adopt a flat directory layout instead of the one with _Headers_ and _Source_
subdirectories.
-
-### Directories
-
-_Headers_ directory usually contains header files or subdirectories which
contain them, but _Headers_ must contain no makefile. Header files should be
handled from _Source_ makefile.
-
-_Source_ directory usually contains source code files or subdirectories which
contain them, and _Source_ must contain a GNUmakefile similar to [this
template](http://svn.gna.org/viewcvs/*checkout*/etoile/trunk/Etoile/Developer/Templates/FrameworkTemplate/Source/GNUmakefile).
-
-Such flexible project layout allows you to add extra directories like
_Plugins_, _Tools_ etc. beside _Headers_ and _Source_ which make the core of
the project.
+For an example, check the [CoreObject
repository](https://github.com/etoile/CoreObject).
+
+When the project is fairly small (few headers and source code files), the
source code can sit directly in the project directory.
### Files
-Project directory must contain the following files formatted in a way similar
to the templates they are linked to:
-
-*
[_ChangeLog_](http://svn.gna.org/viewcvs/*checkout*/etoile/trunk/Etoile/Developer/Templates/FrameworkTemplate/ChangeLog)
(look at ChangeLog Style below too)
-*
[_INSTALL_](http://svn.gna.org/viewcvs/*checkout*/etoile/trunk/Etoile/Developer/Templates/FrameworkTemplate/INSTALL)
-*
[_README_](http://svn.gna.org/viewcvs/*checkout*/etoile/trunk/Etoile/Developer/Templates/FrameworkTemplate/README)
-*
[_GNUmakefile_](http://svn.gna.org/viewcvs/*checkout*/etoile/trunk/Etoile/Developer/Templates/FrameworkTemplate/GNUmakefile)
-
-
-## ChangeLog Style
-
-Within each project (library, application, example, etc.) you should include a
ChangeLog in the project root directory. Typically there is one for each
library, application etc.<br>
-Always include a ChangeLog entry for work that you do (look for the ChangeLog
file in the current directory or look up in parent directories).
-
-Mainly ChangeLog entry shoud look in this example:
-
- 2005-05-21 John Low <[email protected]>
-
- * Source/IKIcon.m ([IKIcon -initWithImage:]): blabla.
-
-_blabla_ is where you add your own comments on the same line (with word
wrapping every 80 characters). Although if you're making similar changes to
multiple methods, it's ok to leave out the function/method name.
-
-Important: Changelog entries should state what was changed, not why it was
changed. It's more appropriate to put that in the source code, where someone
can find it, or in the documentation.
-
-Note: If you are working on a subversion branch, please postfix your changelog
with the branch name.
-
+The project directory must contain the following files formatted in a similar
way:
+
+*
[_INSTALL_](https://raw.githubusercontent.com/etoile/CoreObject/master/INSTALL.GNUstep.md)
+*
[_README_](https://raw.githubusercontent.com/etoile/CoreObject/master/README.md)
+*
[_GNUmakefile_](https://raw.githubusercontent.com/etoile/CoreObject/master/GNUmakefile)
## Source Code Style
_______________________________________________
Etoile-cvs mailing list
[email protected]
https://mail.gna.org/listinfo/etoile-cvs
