OTP version compatibility - not obvious
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 54
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
The information on OTP compatibility for Riak is down the README page, below what can be seen without scrolling, and it talks of a preference and not a requirement.
For new developers, the obvious first step is to use the most up-to-date Erlang version, and this will lead to wasted time addressing compatibility issues.
What can be done to avoid this confusion in the future, e.g. :
- make OTP version support more prominent in the README.
- use
otp_minimum_versionin the rebar.config;- is there a way of specifying and/or warning on otp maximum version?
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
Read the OTP compatibility section in README and the otp_minimum_version setting in rebar.config; first verify how current support is expressed. Done means the supported OTP requirement is prominent and the proposed minimum or maximum-version warning behavior is resolved and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- erlang
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100