Skip to content

template-proposal.md

Latest commit

 

History

History
42 lines (36 loc) · 1 KB

template-proposal.md

File metadata and controls

42 lines (36 loc) · 1 KB

Summary

  • Summary of the thing you want this API to achieve

Example: Proposal API for Input via keyboards, mice, and controllers.

Contributors

  • Your Name (@YourGitHubUsername)
  • Dylan P (@Perksey)

Current Status

  • Proposed
  • Discussed in Community Meeting
  • Approved
  • Implemented

Design Decisions

  • An Explanation of any notable design decisions you went with (i.e. why you designed the API like this) This section is optional

Proposed API

  • Here you do some code blocks, this is the heart and soul of the proposal. DON'T DO ANY IMPLEMENTATIONS! Just declarations.
/// <summary>
/// Represents a grenade.
/// </summary>
public class SilkGrenade
{
    /// <summary>
    /// What does this do?!?
    /// </summary>
    public void RedButton();
    /// <summary>
    /// Detonates the grenade.
    /// </summary>
    protected void Kaboom();
    /// <summary>
    /// Gets or sets whether this grenade is disarmed or not.
    /// </summary>
    public bool Disarmed { get; set; }
}