versioning and incompatibilities
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 118
- Forks
- 43
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 26
Description
There are over 6700 lines of diff between 0.3 and 0.4 and it is not backwards compatible to 0.3 functionality. Please consider:
- Using a changelog to document important changes
- Using semantic versioning to highlight when incompatible changes can be expected. OR declaring that versioning strategy you're using so we don't have to guess if an upgrade is safe or not.
- Maintaining backwards compatibility across tiny bumps of ruby (eg best I can tell, upgrading to ruby 3.3.1 broke one of my gems because of net-imap changes).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by reviewing the project's current release, versioning, and compatibility documentation; done means a documented changelog and explicit versioning and backwards-compatibility policy that makes upgrade impact clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100