thoughtbot / factory_bot

A library for setting up Ruby objects as test data.
https://thoughtbot.com
MIT License
7.93k stars 2.6k forks source link

Create a "Getting Started" section to help beginners to get started 😃 #1707

Open smaboshe opened 4 weeks ago

smaboshe commented 4 weeks ago

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:

OughtPuts commented 4 weeks ago

Happy to be tagged to review if/when we have a PR - @OughtPuts

stratigos commented 4 weeks ago

I just gave it a "test" by trying to get to some initial setup step from the moment I land on the github repo page.

With a couple of intuitive clicks I landed on:

https://thoughtbot.github.io/factory_bot/setup/summary.html

Its linked as README -> book intro -> guide

Perhaps some folks would prefer if that link is linked from the main README instead?