Shopify / Shopify/deprecation_toolkit
Update README to include detailed installation instructions
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 538
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Currently the README skips straight from "what does it do" to "how to use it". I think that "how to set it up" is a missing step between these two.
While attempting to use this Gem I encountered difficulty actually getting it to work for minitest (it was fine in RSpec), so along with the Gem installation instructions it would be useful to go into more detail about where configuration should live. Is it in an initializer? Does it live in test/test_helper.rb?
It would also be useful to have some information about how to use the Gem in a project which has both minitest and RSpec suites (if that's even possible). I love the idea of the Gem - I'm just struggling to get it to work in our dual-suite application right now!
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 README and compare the existing usage section with the missing installation and setup steps. Clarify whether configuration belongs in an initializer or test/test_helper.rb, and document the expected setup for minitest, RSpec, and projects using both suites; done means a newcomer can install and configure the Gem from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100