advanced-cropper / vue-advanced-cropper

The advanced vue cropper library that gives you opportunity to create your own croppers suited for any website design
https://advanced-cropper.github.io/vue-advanced-cropper/
Other
931 stars 130 forks source link

Update migration.md #172

Closed andrew-d-moore closed 2 years ago

andrew-d-moore commented 2 years ago

Let me know if this seems better and I'll work on updating the language for the rest of the documentation.

Norserium commented 2 years ago

@andrew-d-moore, thanks for your contribution.

I will try to review your pull-requests on weekends. This week is pretty busy for me.

Norserium commented 2 years ago

I've added the one comment. The other changes are good.

Alas, I plan to release the next major release in this year, so this section will be rewritten soon anyway.

Norserium commented 2 years ago

@andrew-d-moore, I assume that you did something wrong. Why did you add Update getting-started.md to this pull request?

andrew-d-moore commented 2 years ago

I merged the two branches so that I'd have one working branch as I update files rather than a branch for each file. It would get kinda bloated over time as I submit updates.

Norserium commented 2 years ago

@andrew-d-moore, you can rewrite your history by git rebase -i 50f45f3552a7d308d and then git push -f. I can write a little guide for you if it would be helpful.

andrew-d-moore commented 2 years ago

Yea that might be helpful. I ran those commands it said it rebased but I dont see the history. Appreciate it, thank you.

Norserium commented 2 years ago
  1. You need rewrite history of your branch completely, therefore you can rebase on its parent (master):
    git rebase master -i

Notice, -i mean that you use the interactive mode.

  1. After the executing the last command your default editor will be opened with this content:
    
    pick 44c4d61b Update migration.md
    pick 813b4428 Update migration.md
    pick c299ad8f Update getting-started.md
    pick d5c7bd93 Update getting-started.md

Rebase ddc572ec..d5c7bd93 onto ddc572ec (4 commands)

#

Commands:

p, pick = use commit

r, reword = use commit, but edit the commit message

e, edit = use commit, but stop for amending

s, squash = use commit, but meld into previous commit

f, fixup [-C | -c] = like "squash" but keep only the previous

commit's log message, unless -C is used, in which case

keep only this commit's message; -c is same as -C but

opens the editor

x, exec = run command (the rest of the line) using shell

b, break = stop here (continue rebase later with 'git rebase --continue')

d, drop = remove commit

l, label

t, reset

m, merge [-C | -c ]

. create a merge commit using the original merge commit's

. message (or the oneline, if no original merge commit was

. specified); use -c to reword the commit message

#

These lines can be re-ordered; they are executed from top to bottom.

#

If you remove a line here THAT COMMIT WILL BE LOST.

#

However, if you remove everything, the rebase will be aborted.

#


3. The commented comprehensive description is there already. You need to `drop` redundant commits, `pick` needed commits. Also you can `squash` some commits to single commit if you desire.

Change the content of the opened file to this:

pick 44c4d61b Update migration.md squash 813b4428 Update migration.md drop c299ad8f Update getting-started.md drop d5c7bd93 Update getting-started.md


After that save the file and close an editor.

4. If you squash some commits the new file will be opened. You should input the new commits description here:

This is a combination of 2 commits.

This is the 1st commit message:

Update migration.md

Let me know if this seems better and I'll work on updating the language for the rest of the documentation.

This is the commit message #2:

Update migration.md

Cleaned up a couple empty white spaces too.


Let's leave only one line:

Update migration.md



Save the file and close an editor.

That's all. The rebase is the powerful tool, but remember: with great power, comes great responsibility. It's strongly not recommended to rewrite the history of the public branches.
andrew-d-moore commented 2 years ago

Ok I did it. That was really helpful. I don't bash often, obviously, and yea I can see why changing history would be a bad thing. You don't need to update the language I understood what you were trying to convey. Appreciate it.

I'll be adding more updated Docs over time probably gonna do them in sections now that I have a feel for how you want to say things.

Norserium commented 2 years ago

@andrew-d-moore, thank you for your contribution. I always appreciate that.