Skip to content

Commit

Permalink
add Maintaining CRA fork docs (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
adammockor committed Oct 2, 2019
1 parent eeab0e5 commit f72cee8
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/styleguide/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import TableDocs from './components/Table/Table.docs.mdx';
import PageDocs from './components/Page/Page.docs.mdx';
import TypographyDocs from './components/Typography/Typography.docs.mdx';

import MaintainingCRAFork from './pages/Maintining-CRA-fork.mdx';

styleguide({
config: {
version: pkg.version,
Expand Down Expand Up @@ -85,6 +87,17 @@ styleguide({
render: <Page render={TypographyDocs} />
}
]
},
{
title: 'Docs',
path: '/docs',
nodes: [
{
title: 'Maintaining CRA fork',
path: '/maintaining-CRA-fork',
render: <Page render={MaintainingCRAFork} />
}
]
}
]
});
15 changes: 15 additions & 0 deletions packages/styleguide/src/pages/Maintining-CRA-fork.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Maintaining CRA fork guide

Lighter is fork of [Create React App](https://github.com/facebook/create-react-app) (CRA). To benefit from CRA updates and patches, please follow this guide to synchronize repositories.

## Guide

1. `git checkout upstream` `upstream` branch hosts CRA `master` branch
2. `git fetch upstream` will download upstream changes from CRA
3. `git merge upstream/master` will merge CRA `master` to `upstream`
4. `git checkout -b 'feat/cra-update'`
6. `git rebase upstream` rebase `upstream` on `feat/cra-update`
7. Resolve conflicts and continue rebase `git rebase --continue`
8. `git push --set-upstream origin feat/cra-update` push rebased code to remote
9. Open Pull request on Github to `master`
10. merge

0 comments on commit f72cee8

Please sign in to comment.