Skip to content

Files

Latest commit

 

History

History
37 lines (22 loc) · 1.1 KB

ISSUE_TEMPLATE.md

File metadata and controls

37 lines (22 loc) · 1.1 KB

Issue Title

Be as descriptive as you can with your title. If your issue requests a new topic, preface the title with [NewTopic].

General

We use issues to drive the discussion for changes to existing topics and the creation of new topics.

This way, we have those discussions before significant effort is spent writing a new topic. Click on the Guidelines for Contributing link above for details.

Issues with Existing Topics

If the issue is a simple typo or similar correction, you can just submit a PR. Otherwise, let us know what's wrong or what we should improve. Include a link to the topic.

Requests for new Topics

  1. Tell us where this topic should go in the Table of Contents.

    • Consider where you looked for this information before opening an issue.

  2. Write an abstract

    • In one short paragraph, describe what this topic will cover.

  3. Fill in an outline

    • Write a complete outline for the new topic. We'll help review the outline and approve that before anyone writes a topic.

  4. Suggest reviewers

    • If you know someone who can provide feedback, use '@' to ask them to review.