spinframework / spinframework/spin

[meta] Formalize runtime feature tracking process

Open
#2,992 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
6.5k
Forks
310
Avg merge
1d 20h
Merged PRs (30d)
24

Description

As the Spin runtime gains more downstream consumers I think we need to do a better job of tracking how new features get rolled out across downstream embedders (e.g. spin up, SpinKube), documentation, tooling, etc.

I would propose that every PR that introduces a new runtime feature must include answers (either directly or via linked tracking issue) to a few questions about how the feature will be rolled out.

Some example questions:

  • Is this feature "expected" to be implemented by any/some/all embeddings apart from spin up?
    • What will be the UX of deploying (or trying to deploy) an app to an embedding that does not support this feature?
    • What is the expected level of difficulty for embeddings to implement this feature? e.g. should it "just work" with a Spin upgrade / trivial code changes?
  • What documentation changes should be made to support this feature?

Additionally, if the answers to any of these questions indicate further work, a tracking issue must be created for the feature, to be resolved before the next Spin release including that feature.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed questions for runtime features and how they affect downstream embedders such as spin up and SpinKube, along with documentation and tooling. Done means establishing a formal PR or tracking-issue process, including follow-up work that must be resolved before a release.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.