Contribution Etiquette

General

  • Be considerate - Please don't be rude or offensive.
  • Write in a way that is easy to understand and avoid using local slang or phrases. Many of those who will read your text may not have English as their first language.
  • Don't delete other people's contributions (unless you know what you are doing).
  • Avoid the “click here” phrase.
  • When contributing to a discussion, put your material at the end, so that the page makes sense when read from top to bottom.
  • When you answer a question, put the answer after the question.

Refactoring Pages

  • Be objective - both pros and cons have to be represented correctly. It is easy to make mistakes when you hold strong views about the material you are editing.
  • Be careful with signed contributions - don't change their meaning.
  • Be aware of context. Moving material or deleting or moving surrounding material can change meaning.
  • Use links and cross-references where appropriate.
  • Give credit where credit is due!
Back to top
contribution_etiquette.txt · Last modified: 2009/04/18 13:53 (external edit)

© 2009 The Software Craftsmanship Community