docs inconsistency: stream specific README differs from assemble script
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- build-system, documentation
Research direction
Compare the 3.0 README.md example at line 117, the assemble script at line 67, and the from-dockerfile tests. Start by checking the referenced lines to identify the differing forms. Update the three places to use the same form, then verify they are consistent.
Written by the indexing model from the issue text.
Description
https://github.com/sclorg/s2i-ruby-container/pull/653#discussion_r4246915009
tl;dr the README.md is inconsistent since 3.0 WRT to the form used. Either 3.0 README.md example should also use bundle config set path https://github.com/sclorg/s2i-ruby-container/blob/2dd396b6434da918a7270a53b6df96741053be89/3.0/s2i/bin/assemble#L67 or the assemble script should use the README.md's form https://github.com/sclorg/s2i-ruby-container/blob/2dd396b6434da918a7270a53b6df96741053be89/3.0/README.md?plain=1#L117
Additionally, the form might've stayed the same in from-dockerfile tests.
All 3 of these places should be in-sync.
- Dominant language
- Shell
- Stars
- 55
- Forks
- 156
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from sclorg/s2i-ruby-container
-
Difficulty 1/5 Under an hour Newbie friendliness 73/100
sclorg/s2i-ruby-container#659 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
sclorg/s2i-ruby-container#656 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
sclorg/s2i-ruby-container#655 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
sclorg/s2i-ruby-container#654 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 54/100
sclorg/s2i-ruby-container#658 ·
All issues in sclorg/s2i-ruby-container
Similar issues
-
e2e-failure ready-to-code
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
redhat-developer/rhdh-plugin-export-overlays#4391 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
graygarbage/HermesKey#20 ·
-
review-bot
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
midagedev/bloomery#151 · 1 comment ·
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 1/5 Under an hour Newbie friendliness 85/100
mattpocock/skills#1269 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days