Given the amount of traffic on this list (and traffic on our IRC
channel), I'm wondering if we need to lay down some guidelines.
Anyone have any suggestions? Here are a few of mine:
<disclaimer>This list reflects my own personal opinions</disclaimer>
- If you don't bother to Google your issue (which includes searching
the group archives), you'll only get told to do so later on. If
you're too lazy to search for your answer on your own, the community
is definitely too lazy to do it for you. This goes out to anyone
asking about mod_rewrite issues, HABTM questions, "can anyone
recommend a tutorial?", etc.
- Look up your issue in the manual. Then look for your answer in the
API. If you can't find what you're looking for in the manual or API,
then you might consider looking at the manual and API.
- Look up your issue in the manual and API.
- If the last two items won't do, it might be good to phrase your
question as "I'm looking to do X with CakePHP - what is that called/
what MVC classes should I use/etc. so I can research further?"
- Specific questions always work best.
Good example: "How do I use beforeFilter() in my controllers to
check a user's session?"
Bad example: "How do I do auth using CakePHP?"
Horrific example: "How do I build a forum kthx."
- Specificity is nice, and details add. Include as much information
in the least amount of space. Relevant parts of config files, DEBUG
output examples, etc. all will help people look at your issue. The
easier you make it for others, the faster you will get a response.
- Demanding will always get you nowhere. The tone of your inquiry,
the USAGE of CAPS, or threats to "leave" CakePHP all fit under this
category. I realize that newness to English may play a part in this,
but it isn't an excuse. Please make sure the tone of your inquiry is
respectful and patient.
- Be patient. While bumping your issue might get it answered, it
reveals the foundational assumption that you believe you are owed an
answer. Please remember that people are answering your questions at
their own cost (time). If you have to bump it, you probably didn't
follow one of the guidelines above. Include these tidbits of wisdom
in a follow up reply if you're question goes unanswered.
- If someone helps you, follow their advice. Follow their directions
carefully and respond with details and specificity. Nothing is more
aggravating than helping someone who won't do what you ask them.
- Supplying fake data in your question is always worse than supplying
actual data. Unless you really have a Foo model, and your cake
installation path is /path/to/cake, you're not helping the issue:
you're making it more complex. Supply real error messages, and you'll
be better off.
- Never say "anyone see anything wrong with this?" No one likes to
play debugging Jeopardy. Just tell us what *you* think is wrong so we
can fix it.
- This is just me, but posting application designs and database
schemas to the group seems too much to ask for free. If you want
experienced developers to review your application design, you should
probably hire one.
- Never say something is broken without explaining why you think it
is broken. "That didn't work" is completely useless information. Tell
your benefactor what happened, what error was shown, how much you
like his shirt... anything.
- Please try to stay on topic. I like the relaxed feel in the IRC
channel, but with 120-150 people in there, be careful about taking
over the conversation with plain PHP questions, JS questions, etc.
Take it to a private conversation if possible.
- Critique on a community contributed, open source project is silly
unless you're willing to pony up some help. I've heard people
criticize the docs, a given CakePHP functionality, with no intention
on solving the issue. We're all starving students with alimony,
hospital bills and gambling habits. If you think you're more busy
that the development team, then how are you finding time to critique
our work? Jump in people. This is a community effort.
- Please remember that 1.2 is not a final release. There are no docs,
it is a moving target, it is not complete. Keep that in mind when
you're asking questions about it.
- Avoid private messages to anyone - ask your well-crafted, unique,
researched question in the open where others can benefit from it. If
you think it warrants inclusion in the manual, open a ticket. The
more refining we can do for official CakePHP content outlets, the
better of n00b bakers will be.
Thanks,
John
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Cake
PHP" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/cake-php?hl=en
-~----------~----~----~----~------~----~------~--~---
