Skip to content

Commit

Permalink
(wip): Initial outline of user doc
Browse files Browse the repository at this point in the history
More to come, just wanted to checkpoint this
  • Loading branch information
ahpook committed Jan 19, 2024
1 parent ac585cd commit 010297b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/using-the-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@


## How to get started working with Internal Contribution Forks

* Set up an organization to host your open source work
* Install the app into that organization
* Fork an upstream project into the organization's namespace, creating your **public fork**
* Go into the app and find the fork of the project you want to mirror
* Click **Create mirror** and give it an unambiguous name (such as `teamA-private-mirror`), creating your **private mirror**

## PR workflow once a mirror is active

* Create a pull request against the private mirror repo
* Review and merge the PR - at this step, if issues come up that require the deletion of code in the PR, you should "squash history" in the PR so the merge commit does not contain traces of the unwanted code.
* Once it's merged, the app will automatically sync the private mirror to your public fork, updating a branch whose name matches the name of the private mirror (`teamA-private-mirror`, in this example).
* You can then use that branch of the public fork as the base to open a PR to the upstream repository.

0 comments on commit 010297b

Please sign in to comment.