jamesturk / jellyfish

🪼 a python library for doing approximate and phonetic matching of strings.
https://jamesturk.github.io/jellyfish/
MIT License
2.07k stars 160 forks source link

Submodules in detached state #112

Closed ahood closed 5 years ago

ahood commented 5 years ago

When I forked this repository and cloned to my laptop, the cjellyfish and testdata submodules were in a detached state. Each of them did have master branches, however, where HEAD and master were equal for cjellyfish and master was ahead of HEAD for testdata. This is my first time seeing submodules. Is something messed up that needs to be fixed? I'm planning to just switch to master in both cases before I do a pull request. Is that the right thing to do?

ahood commented 5 years ago

In order to pass checks in my pull request I had to change .gitmodules to point to the submodules in my fork, following what another user did in a separate pending PR. The checks are now passing. Is this the right way to deal with forking and pull requests for a repository with submodules? Perhaps you would consider adding instructions for how submodule newbies like myself should interact with the jellyfish repo and its submodules.

I found this reddit post helpful: https://www.reddit.com/r/git/comments/qatxi/fork_a_github_repo_that_has_submodule/.

jamesturk commented 5 years ago

I wish there were a better way but I think that's it. I'm a bit behind on OSS work but wanted to say thanks for this & I'll do my best to get a quick review in ASAP

On Tue, Jan 1, 2019 at 9:20 PM ahood notifications@github.com wrote:

In order to pass checks in my pull request I had to change .gitmodules to point to the submodules in my fork, following what another user did in a separate pending PR. The checks are now passing. Is this the right way to deal with forking and pull requests for a repository with submodules? Perhaps you would consider adding instructions for how submodule newbies like myself should interact with the jellyfish repo and its submodules.

I found this reddit post helpful: https://www.reddit.com/r/git/comments/qatxi/fork_a_github_repo_that_has_submodule/ .

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/jamesturk/jellyfish/issues/112#issuecomment-450776970, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAfYnINoz8Rj_FYxtVEylBSusy9-qkkks5u_BdogaJpZM4Zf9LJ .

jamesturk commented 5 years ago

ah yeah- can you submit PRs to the two submodule repos?