Yii Framework Forum: Guidelines for extensions - Yii Framework Forum

Jump to content

Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

Guidelines for extensions

#1 User is offline   Maurizio Domba Cerin 

  • Yii - Yesss It Is !!!
  • Yii
  • Group: Yii Dev Team
  • Posts: 4,522
  • Joined: 12-October 09
  • Location:Croatia

Posted 17 May 2011 - 03:11 AM

It's nice to see that the Yii community is very active and willing to share it's work through extensions.
To all of you, keep the good work going. :D

So that all users get better experience, here are some guidelines for creating extensions:

  • use a prefix, so that non-prefixed class names can be used for components / extending classes
  • DO NOT use C as a prefix for your extension classes - C is for Yii core (prefix ideas: E, my, ext, ...)
  • the extension needs to be documented - code without documentation is useless
  • the extension needs to have a download file or link

NOTE: creating a new extension just to preserve space (placeholder), without putting a link for a download and/or without documentation is a bad practice! Users don't like that and all placeholders get many negative votes!

Yii extensions: http://www.yiiframew...com/extensions/
Find more about me.... btw. Do you know your WAN IP?
0

#2 User is offline   Ivica 

  • Advanced Member
  • PipPipPip
  • Yii
  • Group: Members
  • Posts: 320
  • Joined: 25-May 11

Posted 29 June 2011 - 04:06 AM

I do not agree with your ideas about prefixes, prefix should have some meaning, related to what extension should do.

Same about comments, if code is written good, there are no need for comments(this doesn't stay for class/function headers, as that data can be used for class/api specifications). If there are too much comments in code, that mean there is something wrong with code :)
#Be Limitless
Gravity4
0

#3 User is offline   Maurizio Domba Cerin 

  • Yii - Yesss It Is !!!
  • Yii
  • Group: Yii Dev Team
  • Posts: 4,522
  • Joined: 12-October 09
  • Location:Croatia

Posted 29 June 2011 - 04:31 AM

Please read carefully the guidelines a second time...

Note that I wrote documented... not commented... that's two very different things...

as for the prefix... it's up to you what to use... the important thing for this version of Yii is NOT to use "C" as this is used by the Yii core... and the prefix idea I put there are the most used currently if you take a look at the Yii extensions... :D
Find more about me.... btw. Do you know your WAN IP?
0

#4 User is offline   Ivica 

  • Advanced Member
  • PipPipPip
  • Yii
  • Group: Members
  • Posts: 320
  • Joined: 25-May 11

Posted 29 June 2011 - 09:24 AM

Heh, sorry, you are right, documented and commented is not same, my mistake :)
#Be Limitless
Gravity4
0

#5 User is offline   jacmoe 

  • Elite Member
  • Yii
  • Group: Moderators
  • Posts: 3,317
  • Joined: 10-October 10
  • Location:Denmark

Posted 30 July 2011 - 04:45 PM

I feel there should be a review process.
And a requirement that the extension should be in English.
(Extension page too)
It's rather rude in my opinion.
"Less noise - more signal"
0

#6 User is offline   hany sarhan 

  • Newbie
  • Yii
  • Group: Members
  • Posts: 2
  • Joined: 03-October 11

Posted 03 October 2011 - 09:55 AM

For new users, how can i add new extension, and how long i have to wait before adding it, and if i have to post in the forum first, how many posts i have to post?
0

#7 User is offline   samdark 

  • Having fun
  • Yii
  • Group: Yii Dev Team
  • Posts: 4,510
  • Joined: 17-January 09
  • Location:Russia

Posted 04 October 2011 - 03:13 PM

You need to have some forum posts. Something like five or ten. No wait after adding extension itself.
0

#8 User is offline   Blue Spy 

  • Newbie
  • Yii
  • Group: Members
  • Posts: 8
  • Joined: 08-October 11

Posted 08 October 2011 - 02:57 AM

Hello everyone,

I'm quite new in the forum, but I've used Yii for some times.
I am wondering is there supposed to be a standard test for new extensions? like the beta stuff?

No?

Thanks,

Regards,
0

#9 User is offline   samdark 

  • Having fun
  • Yii
  • Group: Yii Dev Team
  • Posts: 4,510
  • Joined: 17-January 09
  • Location:Russia

Posted 10 October 2011 - 05:21 PM

It's up to extension authors. We aren't testing extensions.
0

Share this topic:


Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users