Welcome to the Kite Answers Style Guide

Introduction

What is Kite Answers?

Kite Answers is a collection of high-quality answers to the most commonly asked Python programming questions.

What is the purpose of this style guide?

This style guide is a reference for Kite Answers authors. It shows authors the correct way to write and format an Answer.

What is in the style guide?

  • High-level Guidelines — How to approach writing a Kite Answer
  • Answer Structure Guide — How to structure and organize an Answer
  • Code Sample Guide — How to write good code samples
  • Grammar and Mechanics — How to be consistent with the Kite Answer house style
  • Markdown Guide — Details on Markdown syntax, including Kite add-ons (Coming soon)
  • Template — Template for a Kite Answer
  • Submission Rubric — Instructions for submitting an Answer, including a rubric to assess the quality of your Answer (Coming soon)

Quick Start

  1. Before working on your first Answer, read the entire style guide at least once.
  2. Using the answer-submission-process document, choose and assign a question to yourself.
  3. Using the style guide as a reference, write your Answer.
  4. Review your Answer using the Submission Rubric (coming soon)
  5. Follow the answer-submission-process document guide to submit your Answer for review.

Questions

If you have any questions, please ask! Questions are a great way for us to discover what we need to clarify here, and for us to avoid unnecessary back-and-forth.

Improve this guide

If you have suggestions for additions, improvements, or edits to this guide, file an issue on the kite-answers/style-guide GitHub repository.

General guidelines

Do not copy-and-paste from Stack Overflow

Our relationship with StackOverflow is that we are referring to them to know what topics need better answers. If the answers on StackOverflow were sufficient, our site would not be needed.

Be especially mindful of not replicating variable names, and other arbitrary elements of code samples from StackOverflow.

Also, do not copy text or code from StackOverflow, either directly or with minor changes.