Django Python Web Framework Best Practices

best_practices.md

Read this before you post something:

1. The group is not here to do your homework.

Don't expect others to do everything for you, be it your homework or your job. So try doing something first!

2. Share code nicely.

If you want to share a code, or need help with it, then put it in https://gist.github.com or something similar. This way others can have a better understanding of what your code is about.

3. We take the role of mentors, not as guardians.

Provide constructive feedback for other users and be polite.

4. LMGTFY (Let Me Google That For You)

Don't just link someone question to LMGTFY (even if the question is ridiculously simple). Instead, how about "Hello X, have you tried searching for this on Stack Overflow?"

5. Job postings with enough information.

Job postings should include job description, required skills and location or link to a page containing such information.

6. Don't Spam.

Just don't.

7. Keep the group on the right track.

Remember what this group is about, and if your post really fits in here.

A few additions/questions:

1. As an international group are non-english post acceptable
2. Job postings should include job description, required skills and location or link to a page containing such information
3. maybe we should maintain an FAQ?

@IlianIliev, about the non-english post...
At first I would say that only english is acceptable, but after reading a post on StackOverflow Can’t We All be Reasonable and Speak English? I started to have my doubts.

And I also agree with the FAQ

I think translating this document into multiple languages is a very good idea. :)

@pydanny that's nice, is a gist still the best place to do this, or a github repo is better?

Sometimes examples of what not to do can be helpful.
Examples of poor questions - something easily returned as a 1st level search on google, or clearly explained in the django documentation.

@diek great idea!

@arruda et al,

What about advice for mentors on how to respond when someone posts something that violates these rules? I want this because the last thing I want is for new developers to be insulted or ridiculed for asking questions. Examples of poor behavior on our part (including me):

1. LMGTFY (Let Me Google That For You) is really unpleasant. It's often tied to images and other mocking text. Instead, I want to see something like, "Hello X, have you tried searched for this on Stack Overflow?"
2. "You need to UP your skills" should be replaced by, "Have you tried one of the Python/Django tutorials?"

The idea is to provide constructive feedback, rather than self-gratifying easy statements. It's more work for us, but it makes for a more pleasant community. We take the role of mentors, not as guardians.

Does that make sense?

In any case, this should be summed up in one of the bullets.

@pydanny, you've got a point in that. I'll add this too.

Ok, I've separated it in two files, one meant to be a guideline on answers and the other on questions.

I changed it back to only one file, I think it's better to have this information together.

I agree