Skip to content

Add contributing guide for syncing and backporting#649

Merged
henningkayser merged 1 commit intomainfrom
henning/document-syncing-backporting
Nov 8, 2021
Merged

Add contributing guide for syncing and backporting#649
henningkayser merged 1 commit intomainfrom
henning/document-syncing-backporting

Conversation

@henningkayser
Copy link
Copy Markdown
Member

@henningkayser henningkayser commented Nov 5, 2021

Description

Detailed instructions on how to perform a branch sync (MoveIt 1 -> MoveIt 2) and how to backport changes (link to index.markdown). Fixes moveit/moveit2#45.

Checklist

  • Tested modified webpage locally using the build_locally.sh script
  • While waiting for someone to review your request, please consider reviewing another open pull request to support the maintainers

@henningkayser henningkayser force-pushed the henning/document-syncing-backporting branch from fd5c6ef to feae989 Compare November 5, 2021 10:01
@henningkayser henningkayser self-assigned this Nov 5, 2021
@henningkayser henningkayser force-pushed the henning/document-syncing-backporting branch 3 times, most recently from 1601bca to 8286718 Compare November 5, 2021 10:28
@henningkayser henningkayser force-pushed the henning/document-syncing-backporting branch from 8286718 to 5549516 Compare November 5, 2021 10:32
Copy link
Copy Markdown
Member

@tylerjw tylerjw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ParthasarathyBana and I read through this and it looks good. @Abishalini can you also look through this and verify it makes sense?

Copy link
Copy Markdown
Contributor

@Abishalini Abishalini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just followed all the steps and it looks good to me.

```
git log --oneline moveit1/master $(LAST_SYNC_COMMIT)..HEAD
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another way to visualize all commits that have not been synced

Suggested change
git config --global alias.hist "log --pretty=format:'%C(yellow)[%ad]%C(reset) %C(green)[%h]%C(reset) | %C(red)%s %C(bold red){{%an}}%C(reset) %C(blue)%d%C(reset)' --graph --date=short"
git hist main..moveit1/master

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that aliases like this can make git outputs prettier or even more useful. To me, it would be a little out of scope to add this here or even a bit distracting. Much better would be a reference like: "Hint: you can also use the git hist alias instead of "git log" for some nicer output" along with a link to a source or another "Git Best Practices" section.
I'll leave this change out for now, but feel free to contribute something like this.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually a real improvement in terms of readability. 👍
We don't have a better place to put it, so sprinkling neat tool improvements in such instructions is still nice.

@henningkayser henningkayser merged commit d7bfd41 into main Nov 8, 2021
@delete-merged-branch delete-merged-branch bot deleted the henning/document-syncing-backporting branch November 8, 2021 10:24

```
git fetch origin
git checkout -b pr-sync origin/main
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not justify an update, but in case you didn't know it already:

git switch -c pr-sync origin/main

@v4hn
Copy link
Copy Markdown
Contributor

v4hn commented Nov 9, 2021

Altogether: wow. I guess you've been through hell a number of times following this procedure until now. 🏅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to sync moveit1 and moveit2

5 participants