Skip to content

Add more instructions regarding derived repos #8

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.

Sign up for GitHub

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

Merged
r-spiewak merged 1 commit into from
Jun 18, 2025
Merged

Add more instructions regarding derived repos #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,13 @@ After completing the regular installation above, also do the following:
## Usage in Other Derived Repos

Create a repo based on this template. See https://github.com/marketplace/actions/actions-template-sync to make an Action to make the new repo automatically (make a PR to) sync changes from the template (this) repo.

Alternatively, set this template as an upstream branch and merge in changes accordingly:
1. *Set upstream*: From the derived (downstream) repository, run `git remote add template git@github.com:r-spiewak/python_template`.
2. *Fetch changes*: Run `git fetch template`.
3. *Merge changes* (maybe do this on a branch other than main and make a PR into main): `git merge template/main -- allow-unrelated-histories` (for the main branch in the upstream template).
4. *Fix Merge Conflicts*: Fix the merge conflicts in your local branch.

However, both of these methods are messy, since the package name (`python_template`) changes, and (if the derived repo is created from the gitHub template) the merge will want to revert it back to `python_template` and put anything new into a `python_template` directory as well (since they don't have a shared history).

The possible way to avoid this is if the derived repo is created locally as a copy of this repo, since then they'll have a shared history (and then the flag `--allow-unrelated-histories` in step 3 can be omitted as well).