tauri-apps/archived-rfcs
1
0
Fork 0
mirror of https://github.com/tauri-apps/rfcs.git synced 2026-01-31 00:35:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7 from JonasKruckenberg/main

Browse Source 
Update RFC template
This commit is contained in:
Lorenzo Lewis
2023-03-14 17:33:00 +00:00
committed by GitHub
parent 25804193cf fd0ede8782
commit 207b1a0abe
2 changed files with 77 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
0000-template.md Normal file
View File

@@ -0,0 +1,77 @@
- Feature Name: (fill me in with a unique ident, `my_awesome_feature`)
- Start Date: (fill me in with today's date, YYYY-MM-DD)
- RFC PR: [tauri-apps/rfcs#0000](https://github.com/tauri-apps/rfcs/pull/0000)
- Tracking Issue: [tauri-apps/tauri#0000](https://github.com/tauri-apps/tauri/issues/0000)
# Summary
One paragraph explanation of the feature.
# Motivation
Why are we doing this? What use cases does it support? What will developers, end-users and core-devs gain from this? What is the expected outcome?
# Guide-level explanation
- Explaining the feature largely in terms of examples.
- If applicable, provide sample error messages, deprecation warnings, or migration guidance.
- If applicable, describe how this feature can be taught to existing and new Tauri developers.
# Reference-level explanation
The technical portion of the RFC. Please explain in detail:
- How the feature interacts with other features.
- That it is reasonably clear how the feature would be implemented.
- Any corner cases should be covered by examples.
- Does this require stale dependencies to be forked? What is the long-term impact on core-developers? Does this introduce additional maintenance load?
The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.
## Platform Considerations
Tauri works across a wide variety of platforms (Operating Systems, Architectures, Hardware Configurations). Please explain:
- If applicable, how this feature interacts with different platforms and whether some platforms introduce special behavior.
- If this feature can only be supported on a subset of platforms, explain why.
## Security Considerations
Tauri is a very security conscious project. Please explain in detail:
- How does this feature impacts the security of Tauri apps.
- If applicable, what design decisions you have taken to increase the security of this feature and Tauri apps at large.
- If it's clear that this feature will require the addition of new dependencies, how this feature impact Tauris risk of supply chain attacks.
## Performance Considerations
How will this feature impact the performance of a Tauri app?
## Community Considerations
How does this impact community libraries, tools and other work? Does this invalidate existing tutorials and learning materials?
# Drawbacks
Why should we *not* do this?
What are the limitations of this approach?
# Rationale and alternatives
- Why is this design the best in the space of possible designs?
- What other designs have been considered and what is the rationale for not choosing them?
- What is the impact of not doing this?
- If this is a language proposal, could this be done in a library or plugin instead?
# Prior art
Discuss prior art, both the good and the bad, in relation to this proposal.
A few examples of what this can include are:
- For community proposals: Is this done by some other community and what were their experiences with it?
- For other teams: What lessons can we learn from what other communities have done here?
- Papers: Are there any published papers or great posts that discuss this? If you have some relevant papers to refer to, this can serve as a more detailed theoretical background.
# Unresolved questions
- What parts of the design do you expect to resolve through the RFC process before this gets merged?
- What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?

56
template.md
View File

@@ -1,56 +0,0 @@
# RFC #0001 Webview
<!-- Please take this template and fill out all the sections. You SHOULD have a Tauri member as a sponsor, or alternatively
if this RFC is coming from the Tauri Team, you SHOULD have an external sponsor from the community. -->
| Status | Proposed |
:-------------- | ---------------------------------------------------- |
| **RFC #** | 0000 |
| **Authors** | firstName lastName (email@email.tld / discord handle) |
| **Sponsor** | Tauri team member name |
| **Updated** | 2020-03-10 |
## Objective
Describe the objective in one sentence.
## Motivation
Why would we do something like this? Please describe the needs it addresses.
## User Benefit
What will users of Tauri (whether core-developers, dev consumers or app users) gain from this?
## Design Proposal
### Solution
Please go into gory detail about how this should work. Pseudocode is acceptable.
### Alternatives Considered
What other options are out there?
### Performance Implications
Describe how this change may impact performance?
### Dependencies
Will new dependencies be introduced? Will stale projects need to be forked or assimilated?
### Engineering Impact
Will this increase or decrease build times, developer workload etc.?
### Platforms and Environments
Please consider that core tauri should "just work" on all currently supported platforms. An RFC that only
addresses one platform is not a good candidate.
### Security Impact
What changes will this bring, if any, to the security model of CI, developers and users?
### Tutorials and Examples
What kind of training materials should be made available?
### Compatibility
Will this introduce breaking changes?
### User Impact
Will user's be impacted in any way?
## Questions and Discussion Topics
Are there open questions or anything worthy of discussion?