rubyrubygemssoftware-distribution

What files except LICENSE is a good practice to add to your gem repo?

I wrote gem and published it to github (ex - https://github.com/randx/six)

I added LICENSE file.

I often see VERSION file in other repo - whats the goal?

Any other files should I add?

Solution

  • Chapter 8 of "Ruby Best Practices" by Greg Brown exclusively deals with properly maintaining Ruby projects, including directory layout, files you should include etc. The book is legally available online here:

    http://majesticseacreature.com/rbp-book/pdfs/rbp_1-0.pdf