Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BIP: re-add submodule for BIPs, remove local copy from docs folder #318

Merged
merged 3 commits into from
May 25, 2023

Conversation

guggero
Copy link
Member

@guggero guggero commented May 23, 2023

Now that we have an updated branch for the Taproot Assets BIP (https://github.com/Roasbeef/bips/tree/bip-tap), we can re-add that as a git submodule and remove the local copies in the docs/ folder.

@guggero guggero requested review from Roasbeef and jharveyb May 23, 2023 20:00
Copy link
Collaborator

@dstadulis dstadulis left a comment

Choose a reason for hiding this comment

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

LGTM
Are there any modifications we should make to fetch the BIP info?

You must run two commands: git submodule init to initialize your local configuration file, and git submodule update to fetch all the data from that project and check out the appropriate commit listed in your superproject:

https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules

@guggero
Copy link
Member Author

guggero commented May 24, 2023

Are there any modifications we should make to fetch the BIP info?

I think just the normal git submodule init should be enough.

Copy link
Collaborator

@jharveyb jharveyb left a comment

Choose a reason for hiding this comment

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

LGTM 💯

Verified with diff $MAIN/docs/ $BRANCH/bips/

I had to run git submodule update instead of init, not sure why. I think we want to update the README to use git clone --recurse-submodules on L52, otherwise this dir will be empty.

@guggero guggero added this pull request to the merge queue May 25, 2023
Merged via the queue into main with commit 573ba81 May 25, 2023
11 checks passed
@guggero guggero deleted the bip-tap-submodule branch May 26, 2023 10:43
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.

None yet

3 participants