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.

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(support-guidelines): replace slack with discord references #58

Merged
merged 1 commit into from
Mar 19, 2022

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented Mar 17, 2022

I've also used https://shields.io/ for the interactive join link.

@xmfcx xmfcx requested a review from kenji-miyake March 17, 2022 19:43
@xmfcx xmfcx force-pushed the xmfcx-patch-1 branch 4 times, most recently from e7c062f to a125b9c Compare March 17, 2022 20:01
@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 17, 2022

@kenji-miyake I've added Signed-off-by: M. Fatih Cırıt <[email protected]> to the commit description but DCO still fails.

kenji-miyake
kenji-miyake previously approved these changes Mar 18, 2022
docs/help/support-guidelines.md Show resolved Hide resolved
@kenji-miyake kenji-miyake changed the title replace slack with discord references docs(support-guidelines): replace slack with discord references Mar 18, 2022
@kenji-miyake
Copy link
Contributor

@xmfcx I have two points to share with you.

  1. I've changed the PR title to follow Conventional Commits and to use docs for the type instead of fix.
  • However, since this repository doesn't have any code and it's just a documentation site, we can consider customizing the type.
  1. If you have only one commit, the title of the PR and the title of the commit must be the same because the PR title won't be used when the PR is merged.
  • However, if an admin can merge it carefully (edit the squashed message), this rule isn't mandatory.

image

@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 18, 2022

@kenji-miyake https://github.com/autowarefoundation/autoware-documentation/runs/5594486445?check_suite_focus=true#step:2:20 this still fails because title is not fix: replace slack with discord references why did you change it to be docs(support-guidelines): replace slack with discord references? I didn't understand the reason sorry.

However, since this repository doesn't have any code and it's just a documentation site, we can consider customizing the type.

I understand when the merge is done, it won't care about the title. And it will use the commit message. And it will pass the CI.

But isn't it better to make it consistent with PR titles too?

@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 18, 2022

Also I don't understand why commit sign-off (DCO) didn't work when I tried but it passes now.

@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 18, 2022

Also I don't understand why commit sign-off (DCO) didn't work when I tried but it passes now.

Oh it says:

Commit sign-off was manually approved.

Why did you need to do that? @kenji-miyake ?

@kenji-miyake
Copy link
Contributor

Why did you need to do that? @kenji-miyake ?

@xmfcx It seems the author and committer aren't the same.

image

image

@kenji-miyake
Copy link
Contributor

@xmfcx

why did you change it to be docs(support-guidelines): replace slack with discord references? I didn't understand the reason sorry.

To follow this type definition.
https://github.com/commitizen/conventional-commit-types/blob/c3a9be4c73e47f2e8197de775f41d981701407fb/index.json#L12

I understand when the merge is done, it won't care about the title. And it will use the commit message. And it will pass the CI.

I'm sorry, I couldn't understand this part. 🤔

1 commit: It won't care about the PR title and use the commit title. It's an undesired behavior. So the CI requires the PR title and the commit title to be consistent.
2+ commits: It will care about the PR title.

But isn't it better to make it consistent with PR titles too?

Yes, it's better. So I fixed it and now semantic-pull-request has passed.

@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 18, 2022

@xmfcx It seems the author and committer aren't the same.

Thanks, I was so confused!

@xmfcx
Copy link
Contributor Author

xmfcx commented Mar 18, 2022

To follow this type definition. https://github.com/commitizen/conventional-commit-types/blob/c3a9be4c73e47f2e8197de775f41d981701407fb/index.json#L12

Ah to follow that convention, I had made it into fix: i didn't realize there was also docs: there.

@xmfcx xmfcx enabled auto-merge (squash) March 18, 2022 12:21
@xmfcx xmfcx merged commit 8c1559c into main Mar 19, 2022
@xmfcx xmfcx deleted the xmfcx-patch-1 branch March 19, 2022 03:39
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.

2 participants