[RFC|Accepted] Coding Guideline Modifications

[igorw]

Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.

Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.

Use the built-in isset() function

Begin picky here, isset is not a function but a language construct. Looks good.

[EXreaction]

Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.

Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.

I like the idea, but the auto-updater would be huge+, not the best for 3.1 I'd say. Maybe for 4.0.

[sajaki]

The file header still needs to be adjusted. Currently it is:

Code: Select all

/**
*
* @package {PACKAGENAME}
* @version $Id: $
* @copyright (c) 2007 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/

I'd suggest something among the lines of:

Code: Select all

/**
*
* @package {PACKAGENAME}
* @copyright (c) 2010 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License, version 2
*
*/

This should only apply to files new to the develop (ascraeus) branch.

i would accept this change for phpbb core code, but for mods ?
I'm using SVN VCS (Googlecode), and so i don't see the point of removing * @version $Id: $.

[igorw]

MODs can of course retain the $Id$, this is just for the core.

[DavidIQ]

i would accept this change for phpbb core code, but for mods ?
I'm using SVN VCS (Googlecode), and so i don't see the point of removing * @version $Id: $.

I don't foresee us enforcing this at all for MODs so don't worry about it. While we have decided to use github, which is part of the reason we are removing this line, everyone else can use whatever service they'd like to use (SF, GCode, etc.) so this part of the guidelines may not apply for all MOD writers anyways.

[nickvergessen]

Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.

Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.

I like the idea, but the auto-updater would be huge+, not the best for 3.1 I'd say. Maybe for 4.0.

if we only do that, for files that got changed, it should be not much more work than it is now right?

[naderman]

Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.

I'm not sure we should do that. The info is rather unreliable cause the file might still have been changed.

[igorw]

I adjusted my suggestion. The old line read "GNU Public License", the name of the license really is "GNU General Public License" though.

[bantu]

I suggest removing $Id$ from all files just as we removed the ?> lines.

[igorw]

See viewtopic.php?p=213561#p213561