Skip to content

Instantly share code, notes, and snippets.

@fmendes6

fmendes6/DiscussionGuidelines.md

Forked from ZacSweers/DiscussionGuidelines.md
Created November 23, 2017 08:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save fmendes6/4a9076e25a94fd93a77306e3aa9e59ad to your computer and use it in GitHub Desktop.
Save fmendes6/4a9076e25a94fd93a77306e3aa9e59ad to your computer and use it in GitHub Desktop.
Download ZIP
Discussion guidelines
Raw
DiscussionGuidelines.md

Guidelines

To keep the arguments and examples to the point there are few helpful rules:

  • No abstract examples/arguments. These cause the discussion to lose focus and make examples harder to follow. The example/argument must be traceable to a real-world problem - ___ is intended to solve real problems, not imaginary ones.
  • Examples must show the full complexity of the problem domain. Simplified examples trivialize the problems and the solutions intended to solve those simplified examples may not work for the complex problems.
  • Examples of problematic ___ code must be the “best way” of writing the code in ___ - if it can be improved then the improved version should be used instead.
  • Arguments must be straight to the point and as concise as possible.
  • Arguments should take the point of view of an average programmer - not the über-programmer who doesn’t make design mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment