diff --git a/.gitmodules b/.gitmodules index 29ccaaad0..20dbca5ae 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,9 +1,9 @@ [submodule "website/themes/uswds"] path = website/themes/uswds - url = git@github.com:usnistgov/hugo-uswds.git + url = https://github.com/usnistgov/hugo-uswds.git branch = master update = rebase [submodule "support/schematron"] path = support/schematron - url = git@github.com:usnistgov/schematron.git + url = https://github.com/usnistgov/schematron.git branch = master diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45129cfe1..fa0231db7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,3 +91,39 @@ This project is in the public domain within the United States, and copyright and ## Contributions will be released into the public domain All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest. + +## Git Client Setup + +### Initializing Git submodules + +This GitHub repository makes use of Git submodules to mount other repositories as subdirectories. + +When cloning this repo for the first time, you need to initialize the submodules that this repository depends on. To do this you must execute the following command: + +``` +git submodule update --init +``` + +You can perform the clone and submodule initialization in a single step by using the following command: + +``` +git clone --recurse-submodules https://github.com/usnistgov/metaschema.git +``` + +### Configuring Submodules to Use SSH + +Some clients will make use of Git over SSH with a private SSH key for GitHub projects. For convenience, the submodules are configured to use HTTP instead of SSH. To override this default behavior, you will need to configure your Git client to use SSH instead of HTTP using the following command: + +``` +git config --global url."git@github.com:".insteadOf https://github.com/ +``` + +This instructs your Git client to dynamically replace the HTTP-based URLs with the proper SSH URL when using GitHub. + +### Updating submodules + +Submodule contents will be periodically updated. To ensure you have the latest commits for a configured submodule, you will need to run the following command: + +``` +git submodule update --init --recursive +``` diff --git a/website/themes/uswds b/website/themes/uswds index f82fad414..1e4176d11 160000 --- a/website/themes/uswds +++ b/website/themes/uswds @@ -1 +1 @@ -Subproject commit f82fad4148839781bb49c6b64cdfd1270e7641ba +Subproject commit 1e4176d113972e8f721ea179c29fe0a5478457a9