Re: Questions of code standards
| From: | Michael Gower | Date: | Fri, 18 Jul 2008 04:07:28 +0000 |
| Subject: | Re: Questions of code standards | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-50413@lists.php.net to get a copy of this message | ||
Greetings,
I can answer questions 4 & 5 and suggest on 1.
On Thu, Jul 17, 2008 at 6:35 PM, Kristopher Ives <kristopher.ives@gmail.com>
wrote:
> I wish to propose a package I developed called Services_Shipping (I hope)
> that provides a unified driver-based abstract shipping API, similar to how
> MDB2 provides portable database package and Payment_Process provides
> driver-based transactions.
>
> I code in a different way than PEAR's coding style standards, mainly I use
> tabs and don't like spaces between my opening brackets. I use Eclipse
> currently and will likely create an Eclipse formatting profile for
> formatting to PEAR standard.
>
> 1.) Anyone currently code using tabs and have an Eclipse or bash script
> (using some whitepsace program) that formats to PEAR standards?
I know you can double check that an operation worked with the
PHP_CodeSniffer package.
2.) My PEAR package has 80+ source files, is this a problem? I am not
> interested in combining source files into larger ones.
As long as it's a good design given the complexity of the problem domain it
should be fine.
> 3.) Should I include my 2 driver packages (UPS and DHL) in my original
> proposal for Services_Shipping (these would be Services_Shipping_UPS and
> Services_Shipping_DHL, correct?)
>
> 4.) Should I generate documentation (phpDocumentor) and include the
> documentation or only submit my code and PEAR will generate the doc?
>
In your package description there is a place for a link to the
documentation. Generate the documentation and put it onto a web server and
link it.
> 5.) After proposal will I get a reason why my package isn't accepted so I
> may fix the issues and re-submit? Is there a limit on how quick I may
> re-submit my proposal?
During the voting process you can see comments and reasons for the
individual developer's vote.
When I did it there was no way to actually re-submit. I had to post to this
list to get my old (rejected) package renamed so I could create a new
package with all of the same info in it but at the beginning of the process.
I started my project (Log_XML) in October 2006 and haven't had any
problems. I'm not sure if / when the rejected packages' data gets deleted
from the pear database though.
I hope this helped,
Michael Gower