Skip to content

Update repo to follow Gem development conventions#11

Merged
nirga merged 1 commit intotraceloop:mainfrom
JaredShay:gemfile-cleanup
Jul 19, 2024
Merged

Update repo to follow Gem development conventions#11
nirga merged 1 commit intotraceloop:mainfrom
JaredShay:gemfile-cleanup

Conversation

@JaredShay
Copy link
Copy Markdown
Contributor

@JaredShay JaredShay commented Jul 18, 2024

Adds a few quick updates from bundling the repo locally.

  • Remove Gemfile from root directory
    • The root directory does not appear to need a Gemfile as it is not a library or app, and it doesn't seem like that will be the case in the future
  • Add gemspec to the repository gem's Gemfiles.
    • This allows the gemspec files to specify the gem's dependencies which can be installed with bundle install by contributors. The docs for the method can be found here
  • Add lock files to .gitignore
    • As the directories in this repo are gems, they will be targeting a range of versions, not a specific "locked" set of dependencies. By ignoring the lock files, the repo stays in a clean state after bundling, and the various gems can be developed against a range of dependency versions.

These conventions follow what is outlined in https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/.

Copy link
Copy Markdown
Member

@nirga nirga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JaredShay, I'm not sure I completely understood the rational behind this - mind explaining?

@JaredShay
Copy link
Copy Markdown
Contributor Author

Thanks @JaredShay, I'm not sure I completely understood the rational behind this - mind explaining?

Yes, apologies. I pushed this up quickly while bundling the repo and never updated the description. The PR now has a description and reasoning behind each change.

@JaredShay JaredShay changed the title Cleanup gemfile Update repo to following Gem development conventions Jul 19, 2024
@JaredShay JaredShay changed the title Update repo to following Gem development conventions Update repo to follow Gem development conventions Jul 19, 2024
Copy link
Copy Markdown
Member

@nirga nirga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this! I'm a bit rusty on Ruby from my days at Fiverr 😅

@nirga nirga merged commit 3056da9 into traceloop:main Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants