Assume that there's a git repository A. A has a submodule B. B has a submodule C.
When I'm working on C, the current implementation won't choose A as the project root even though the project-vc-merge-submodules is non-nil.
I can customize project-find-functions to find the right project root as a workaround, but I think this might be a bug need to be fixed.