From aeae77723fda0f35bff17921019c352efe466d51 Mon Sep 17 00:00:00 2001 From: alan Date: Wed, 29 Nov 2023 16:23:48 -0500 Subject: [PATCH] Make committing tutorial --- assets/commit1.png | 3 +++ assets/commit2.png | 3 +++ assets/commit3.png | 3 +++ assets/commit4.png | 3 +++ assets/commit5.png | 3 +++ assets/commit6.png | 3 +++ assets/commit7.png | 3 +++ guides/commit.md | 34 ++++++++++++++++++++++++++++++++++ 8 files changed, 55 insertions(+) create mode 100644 assets/commit1.png create mode 100644 assets/commit2.png create mode 100644 assets/commit3.png create mode 100644 assets/commit4.png create mode 100644 assets/commit5.png create mode 100644 assets/commit6.png create mode 100644 assets/commit7.png diff --git a/assets/commit1.png b/assets/commit1.png new file mode 100644 index 0000000..edafce7 --- /dev/null +++ b/assets/commit1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:955cc8d8a64700116bfbf24cc591c4881d7c1839fd82f4b759d410c3a3d3dd51 +size 73830 diff --git a/assets/commit2.png b/assets/commit2.png new file mode 100644 index 0000000..48c170f --- /dev/null +++ b/assets/commit2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbb2ca08dff2ec187ba134b5eba9bbb2135496882318633962fb9c9b37771337 +size 28783 diff --git a/assets/commit3.png b/assets/commit3.png new file mode 100644 index 0000000..96ad9a9 --- /dev/null +++ b/assets/commit3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bdf79e7af06a139057efc2709d8d43b8da7cb13671a30dfb2d6bb2a1c6610b78 +size 44018 diff --git a/assets/commit4.png b/assets/commit4.png new file mode 100644 index 0000000..465b961 --- /dev/null +++ b/assets/commit4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7fef0e1070230cadd7bac9a7d28876019c17e6e757f8b9374cf11719ec925ab6 +size 48290 diff --git a/assets/commit5.png b/assets/commit5.png new file mode 100644 index 0000000..acbfb0b --- /dev/null +++ b/assets/commit5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:892e6d01703aa756dc5572196b09170fa8ba2591d26584fb8f3c7611a7c62a8d +size 91309 diff --git a/assets/commit6.png b/assets/commit6.png new file mode 100644 index 0000000..3e84dde --- /dev/null +++ b/assets/commit6.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4cc801837205a8959839e624eeee3404a4b26b4320f604de894a187d907a508 +size 28603 diff --git a/assets/commit7.png b/assets/commit7.png new file mode 100644 index 0000000..8f838df --- /dev/null +++ b/assets/commit7.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:51786f4173a18bce6b096ce9f9d5d3668cad01a927cf735734e3f1e9f168c612 +size 130822 diff --git a/guides/commit.md b/guides/commit.md index 98e541d..2c3258a 100644 --- a/guides/commit.md +++ b/guides/commit.md @@ -1,2 +1,36 @@ # Committing Code and Assets +To submit work to the cloud so other users can see it, you must "commit" your work, then "push" it to the cloud. +## Fetching/Pulling Data +Before you start working however, or committing, it's ideal you pull the latest changes. To do so, simply click this button to "fetch" the cloud data. + +![](../assets/commit2.png) + +If the button changes and shows an arrow pointing down, that means you do not have the latest changes! Press the button again to "pull" them down. I suggest closing Unreal Engine (or other software) while doing this. + +## Making a Commit +On GitHub Desktop, we can see a list of changes we've made to the project. Note the list of added files on the left. + +![](../assets/commit1.png) + +I added some posters, and a basic poster blueprint. I tested the poster in a level, but did not intend to actually modify the level. You can see this by the first asset I have on the top: `Content\__ExternalActors__\Maps\L_LevelDesignTest\...uasset`. Since I don't want it saved, I'm going to discard the changes by right-clicking on it. + +![](../assets/commit3.png) + +After that, I verify that the list of changes is correct, add a commit message (so others know what I did), and commit to the repository. + +![](../assets/commit4.png) + +However, this didn't upload the changes to the repository! To do so, I mush "push" my changes. + +![](../assets/commit5.png) + +Finally, if you haven't set it up before, GitHub Desktop is going to ask for your credentials. Just use what you log into Gitea with! + +![](../assets/commit6.png) + +And viola! Your changes should show up in the cloud. + +![](../assets/commit7.png) + +Thanks for contributing!