Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 1.84 KB

ISSUE_TEMPLATE.md

File metadata and controls

46 lines (25 loc) · 1.84 KB

Below are templates for issues for bugs, enhancements or optimizations, and new features. Please delete whichever sections of the template you do not need.

Make sure to add the correct labels to your issue. For example, add the bug label if you're creating a new issue for a bug.

Bugs

A short description of what the bug is. Try to keep it to a single-paragraph "elevator pitch" so the reader understands the problem.

  • Your Swift version (eg - Swift 3.1)
  • Your version of Observe (eg - v0.1.1)
  • What platform are you using? (eg - OS X, Linux)
  • What are the steps to reproduce this issue?

Feature, Enhancement, or Optimization

Name of Feature

Introduction

A short description of what the feature is. Try to keep it to a single-paragraph "elevator pitch" so the reader understands what problem this proposal is addressing.

Motivation

Describe the problems that this proposal seeks to address. Why should this enhancement or new feature be added to Observe?

Proposed solution

Describe your solution to the problem. Provide examples and describe how they work. Show how your solution is better than current workarounds: is it cleaner, safer, or more efficient?

Code snippets

Give us an idea of what this new idea will look like in code. The more code snippets you provide here, the easier it will be for the community to understand what your idea is.

Impact

Describe the impact that this change will have on existing code. Will some Vapor applications stop compiling due to this change? Will applications still compile but produce different behavior than they used to?

Alternatives considered

Describe alternative approaches to addressing the same problem, and why you chose this approach instead.