Silk.NET/documentation/proposals
Dylan Perks f698417cdf
Revert changes to original input proposal
2024-02-23 15:38:29 -06:00
..
(On hold) Proposal - Input maps.md extra features to the input proposal (#1953) 2024-02-23 15:36:35 -06:00
(Rejected) Proposal - Better Strings.md [2.0] Proposal for better strings (#149) 2020-06-20 17:15:14 +01:00
(Rejected) Proposal - Load overrides.md Load override proposal (#336) 2020-10-23 20:39:49 +01:00
(Rejected) Proposal - Platform Hints.md [1.X] [WIP] Platform hints proposal (#153) 2020-04-20 14:46:43 +01:00
(Rejected) Proposal - Region Specific Key Input.md [Rejected] Region Specific Keyboard Input (#397) 2021-03-13 17:44:01 +00:00
(Superseded) Proposal - Enhanced Input Events.md WebGPU bindings (#1114) 2022-11-09 19:06:33 +00:00
(WIP) Proposal - SIMD (Revision).md Update and rename Proposal - SIMD (Revision).md to (WIP) Proposal - SIMD (Revision).md 2022-11-03 12:56:44 +00:00
Proposal - 3.0 & 3.X Software Development Plan.md Update proposed new versioning rules for easier preview build usage (#1682) 2023-11-20 13:57:57 -06:00
Proposal - 3.0 Managed Chain Changes.md Proposal - 3.0 Managed Chain Changes (#1791) 2023-11-21 00:05:39 -06:00
Proposal - Bitwise - Scalar.md Minor proposal changes (#668) 2021-11-04 10:31:40 +00:00
Proposal - Chain Polymorphism.md Chain Polymorphism Proposal (#1145) 2023-01-08 21:29:00 -08:00
Proposal - Contexts.md [1.X/2.0] Context proposals (#166) 2020-04-23 13:49:44 +01:00
Proposal - Generation of Library Sources and PInvoke Mechanisms.md Proposal containing the results of the SilkX experiment (#1727) 2024-02-12 12:45:01 -06:00
Proposal - Generic Math.md Proposal containing the results of the SilkX experiment (#1727) 2024-02-12 12:45:01 -06:00
Proposal - Input.md .NET Foundation Onboarding (#425) 2021-03-18 18:49:58 +00:00
Proposal - Multi-Backend Input.md Revert changes to original input proposal 2024-02-23 15:38:29 -06:00
Proposal - Rumble.md A proposal for a vibration/rumble API. (#46) 2019-08-13 21:12:24 +02:00
Proposal - Vectorization - SIMD.md Change result type of SIMD Sign (#685) 2021-11-17 18:40:56 +01:00
Proposal - Views.md Strip down the core windowing APIs into a mobile-friendly "view" interface (#87) 2019-12-29 19:41:15 +00:00
Proposal - Vulkan Struct Chaining Metadata extensions.md Vulkan struct chaining (#706) 2021-12-03 11:31:39 +00:00
Proposal - Window Hosts (Monitors).md Add a window hosts API for monitor management and subwindows. (#90) 2019-12-29 19:41:03 +00:00
Proposal - Windowing (Revision).md Revise the windowing API to allow for more freedom (#54) 2019-09-29 20:07:26 +01:00
Proposal - Windowing 3.0.md Fixing minor typo (#1001) 2022-08-05 10:37:01 +02:00
Proposal - Windowing.md Rename events in windowing + update provisional changelog 2019-08-05 00:40:14 +01:00
readme.md Merge Silk.NET-Docs with the main repo 2019-06-20 15:27:38 +01:00
template-proposal.md Add contributors to proposals 2019-06-20 15:31:04 +01:00

readme.md

Proposals

Similar to the C# team, we use API proposal documents to discuss the surface API of Silk.NET. We only do this for new modules and subsystems, however (you won't need to make a proposal for just one function)

Workflow

Our API proposals go through this process:

  • Proposed
  • Discussed with Code Owners
  • Revision (if applicable)
  • Approved/Rejected
  • Implementation in the library itself

What's the point

We use API proposals as a way for ironing out the Silk.NET API before actually implementing it in the library. This reduces fuss come reviewing the library PR, and allows another contributor to pick up where another left off, should an implementation PR become stale/inactive.

New Proposals

Here's the template new proposals should follow: template-proposal.md