How should projects depend on ruby2_keywords?
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 77
- Forks
- 13
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 2
Description
Hi, we would like to depend on ruby2_keywords in https://github.com/mongodb/mongoid/. To this end I have been researching what we should use in the gemspec for the version range of ruby2_keywords, and I would appreciate an official clarification on this:
- ruby2_keywords readme itself does not provide a version range
- Rails, despite using ruby2_keywords, does not appear to explicitly depend on it. However https://github.com/rails/rails/blob/main/Gemfile.lock contains two Rails dependencies that depend on ruby2_keywords, one of them uses
>= 0.0.4and another one uses~> 0.0.1. - Currently ruby2_keywords is at version 0.0.5. Are backwards breaking changes expected? What is preventing the version from being 1.0?
Any thoughts are appreciated.
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
Start with the ruby2_keywords README and the Rails Gemfile.lock examples linked in the issue. Document the supported dependency range, compatibility expectations, and rationale for the versioning policy so projects such as Mongoid can choose a gemspec constraint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100