docs: upgrade and version-skew policy

Open
  • Is something wrong?
#421 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
18/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active
Domain
documentation, release

Research direction

The payload names no files, tests or entry points. Start by checking the repository's existing release tags, changelog and versioning notes to see what is already documented. The support windows, version pairings and rollback steps are maintainer decisions, so confirm them with the maintainers before drafting. Done means a published policy document and a compatibility matrix that follows it.

Written by the indexing model from the issue text.

Description

P1 safe v1.0

Why

Self-hosters fear upgrades. They need to know what is supported and how to move between versions safely.

What

  • Supported versions, how long each is patched
  • Which package versions work with which API version
  • Zero-downtime upgrade steps and rollback

Done when

The policy is published and the compatibility matrix follows it.

Dominant language
TypeScript
Stars
2
Forks
2
Avg merge
11h 40m
Merged PRs (30d)
104

Getting set up

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.

More from fells-code/seamless-auth-api

All issues in fells-code/seamless-auth-api

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.