Back to Wails

Wails Enhancement Proposal (WEP)

v3/wep/WEP_TEMPLATE.md

2.14.01.7 KB
Original Source

Wails Enhancement Proposal (WEP)

Title

WEP Number: (leave blank, assigned on acceptance)
Status: Draft
Author: [Your Name]
Created: [YYYY-MM-DD]
Discussion: [optional link to any prior discussion of the idea]
Implementor: [who has agreed to implement this, may be the author] Target: Wails v3

Summary

Provide a concise summary of the proposal.

Motivation

Explain the problem this proposal aims to solve and why it is necessary.

Detailed Design

Provide a detailed description of the proposed feature, including:

  • Technical details
  • Implementation steps
  • Potential impact on existing functionality

Non-Goals

State what this WEP intentionally does not cover.

Platform Considerations

Describe how the feature behaves on each platform (Windows, macOS, Linux, and mobile where relevant). Include:

  • Platform-specific behaviour, limitations or API differences
  • Any platform where the feature is unsupported, and why

Pros/Cons

List the pros and cons of the proposed solution.

Alternatives Considered

Discuss alternative solutions or approaches that were considered.

Backwards Compatibility

Address any potential backward compatibility issues.

Security and Privacy

Describe relevant security, privacy, permissions, or data-handling effects. If there are none, say so.

Test Plan

Outline a testing strategy to ensure the feature works as expected.

Reference Implementation

If applicable, include a link to a reference implementation or prototype.

Maintenance Plan

Describe how the feature will be maintained and supported in the long term.

Conclusion

Summarize the benefits of the proposal and any final considerations.