docs: Add fork branch strategy documentation #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documents the two-branch model used in the Intercom fork: - main: Clean upstream mirror (auto-synced weekly) - fork-main: Active development with pending upstream contributions Explains the fast-track workflow for using features before upstream acceptance while maintaining automated sync capabilities.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### `main` - Upstream Mirror | ||
| - **Purpose**: Clean mirror of the upstream `open-telemetry/opentelemetry-ruby-contrib` main branch | ||
| - **Updates**: Automatically synced weekly via GitHub Actions ([workflow](https://github.com/intercom/intercom/blob/master/.github/workflows/sync-org-forks.yml)) |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/intercom/intercom/blob/master/.github/workflows/sync-org-forks.yml Status: 404
|
|
||
| ## Questions? | ||
|
|
||
| For questions about this fork or the branch strategy, ask in #builder-tools or consult the [sync workflow documentation](https://github.com/intercom/intercom/blob/master/.github/workflows/sync-org-forks.md). |
There was a problem hiding this comment.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/intercom/intercom/blob/master/.github/workflows/sync-org-forks.md Status: 404
Adds a pull request template that reminds developers to target fork-main instead of main. The template includes: - Clear warning about base branch selection - Explanation of branch purposes (fork-main vs main) - Standard PR sections (Why, How, Test Plan) - Link to FORK.md documentation This helps prevent accidentally creating PRs against the locked main branch which is reserved for automated upstream syncing.
The PR template was starting with a level 2 heading (##), which violated markdown lint rules requiring the first heading to be level 1 (#). This change updates the first heading to use the correct level 1 format.
IslaHoe
approved these changes
Oct 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
The Intercom fork uses a two-branch model that needs documentation so team members understand:
fork-main)mainbranch)Without this documentation, it's unclear why we have two branches and how to work with them.
How?
Created
FORK.mdthat documents:main(upstream mirror, auto-synced) vsfork-main(active development)The documentation follows the established pattern from the Intercom monolith's sync workflow and provides practical commands for common operations.