getsops / getsops/sops

Clarification on backward compatibility

Open
#589 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
23.1k
Forks
1.1k
Avg merge
1d 11h
Merged PRs (30d)
9

Description

Taken from the README:

sops will remain backward compatible on the major version, meaning that all improvements brought to the 1.X and 2.X branches (current) will maintain the file format introduced in 1.0.

I'm not seeing these branch names, though I'm sure I've the gist of it.

We use 3.X right now, so as long as I'm using 3.X, all 3.X files should just work right? And when 4.X comes out, will 3.X versions work too? Or should we stick to 3.X only managing 3.X versions?

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 with the compatibility statement in the README and compare it with the repository’s documented version policy. Confirm what backward compatibility means for 3.X files and future major versions with maintainers, then update the README so the supported version relationships and limits are explicit.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.