Skip to content

Instantly share code, notes, and snippets.

@ZacSweers

ZacSweers/DiscussionGuidelines.md

Created November 20, 2017 07:04
Show Gist options
  • Save ZacSweers/a2bb381aa184b353a383107c1739c964 to your computer and use it in GitHub Desktop.
Save ZacSweers/a2bb381aa184b353a383107c1739c964 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.
@ZacSweers
Copy link
Author

Note that I did not write these. These are guidelines I came across in an internal doc and anonymized for general use. Replace ___ with whatever subject you're discussing :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment