Skip to content
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

docs: Updates docs to add mentions of beta #44

Merged
merged 11 commits into from
Mar 14, 2023
Merged

docs: Updates docs to add mentions of beta #44

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1a85557
Updates to `beta` from `main`
sadiejay Sep 10, 2022
fef7f20
Adds note about `beta` branch for open-sauced/hot
sadiejay Sep 10, 2022
53f5b49
Improves visual formatting of note
sadiejay Sep 11, 2022
219f6e3
Remove metion of `beta` and `main`.
sadiejay Sep 22, 2022
3a23757
Removes mention of `main` branch and note
sadiejay Sep 22, 2022
7773536
Update docs/technical/resolve-merge-conflicts.md
bdougie Oct 7, 2022
ddd2098
Update docs/technical/resolve-merge-conflicts.md
bdougie Oct 7, 2022
5c4eb68
Update docs/technical/resolve-merge-conflicts.md
bdougie Oct 7, 2022
397d290
Updates documentation to be branch agnostic
sadiejay Oct 13, 2022
835ae3e
Apply suggestions from code review
bdougie Oct 18, 2022
05a6ecd
Merge branch 'main' into updates-to-beta
bdougie Mar 14, 2023
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
2 changes: 1 addition & 1 deletion docs/contributing/introduction-to-contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For more info on testing React and JavaScript, check out this course [Testing Ja

___We actively welcome your pull requests, however linking your work to an existing issue is preferred.___

1. Fork the repo and create your branch from `main`.
1. Fork the repo and create your branch from the default branch.
1. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile
1. If you've added code that should be tested, add tests.
1. If you've changed APIs, update the documentation.
Expand Down
11 changes: 7 additions & 4 deletions docs/technical/resolve-merge-conflicts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ git remote add upstream git@github.com:open-sauced/open-sauced.git

## Update

First get the `main` branch changes:
First get the default branch changes:


```shell
git fetch origin --recurse-submodules=no --progress --prune
Expand All @@ -59,7 +60,8 @@ git merge upstream/main --no-stat -v

## Merge with upstream

Then merge with the forked up-to-date `main` branch:
Then merge with the forked up-to-date `HEAD` (default branch):
bdougie marked this conversation as resolved.
Show resolved Hide resolved


```shell
git merge origin/main --no-ff -v
Expand All @@ -85,6 +87,7 @@ It will look like this:

Since this pull request does not modify the `package.json` file it is safe to fast forward the changes from `origin/main`:


```shell
# overwrite with origin/main changes
git show :3:package.json > package.json
Expand Down Expand Up @@ -145,9 +148,9 @@ When dealing with dependency and lock file updates there are multiple use cases

However when that happens, it is advised to:
- fast-forward `npm-shrinkwrap.json`
- fast-forward deleted and modified `upstream/main` changes to `package.json`
- fast-forward deleted and modified `upstream/HEAD` changes to `package.json`
bdougie marked this conversation as resolved.
Show resolved Hide resolved
- fast-forward your added lines to `package.json`
- run `npm ci` to delete local modules and create dependency resolution from `upstream/main`
- run `npm ci` to delete local modules and create dependency resolution from `upstream/HEAD`
bdougie marked this conversation as resolved.
Show resolved Hide resolved

Visual diffing is advised however not following the git commit history procedure will result in a rogue pull request that scope creeps into dependency updates.

Expand Down