ruby / gem_rbs_collection

A collection of RBS for gems.
MIT License
246 stars 101 forks source link

Stop recommending git submodule #531

Closed pocke closed 3 months ago

pocke commented 3 months ago

This PR removes the git submodule suggestion from the boilerplate generator and the document.

This change is for #520. In the new system, A PR author can merge the PR if it includes only files under gems/GEM_NAME/. But .gitmodules file is on the root directory.

I think the submodule is rarely utilized, and it introduces other difficulties (slow git clone, traps on renaming directories, and so on). Therefore, I'd like to stop adding a new submodule to this repository.

This PR does not remove existing submodules. They can still be available. (Perhaps I will remove them in the future if no one uses them)

BTW, the script, which will be introduced in #520, can turn on the submodule support if there is a demand. I'll decide whether it supports git submodule or not after a while.