factory_bot icon indicating copy to clipboard operation
factory_bot copied to clipboard

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

Open smaboshe opened this issue 1 year ago • 2 comments

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

smaboshe avatar Oct 25 '24 13:10 smaboshe

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

OughtPuts avatar Oct 25 '24 13:10 OughtPuts

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?

stratigos avatar Oct 25 '24 13:10 stratigos