thoughtbot / thoughtbot/factory_bot
Create a "Getting Started" section to help beginners to get started 😃
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 8.2k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
During Open Summit 2024, we noticed that we don't have a section in the README that helps beginners with the basics of contributing to Factory Bot. The existing documentation might be a little intimidating for a first-time contributor. How might we create something a little friendlier.
This may also apply to first-time users of Factory Bot.
Also applies to:
- #1671
Contributor guide
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
Review the README and existing CONTRIBUTING.md, along with the related issue #1671, to identify the beginner guidance that is missing. Define a friendlier Getting Started section for first-time contributors and, if applicable, users; done means the README contains clear introductory steps without relying on the intimidating existing guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100