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

[Epic] Conventional commits #42748

Open
2 of 3 tasks
WiNloSt opened this issue May 16, 2024 · 0 comments
Open
2 of 3 tasks

[Epic] Conventional commits #42748

WiNloSt opened this issue May 16, 2024 · 0 comments
Assignees
Labels
.CI & Tests Embedding/SDK Embedding SDK for React .Epic Feature Implementation or Project

Comments

@WiNloSt
Copy link
Member

WiNloSt commented May 16, 2024

Description

We want a way to generate SDK changelog easily, and possibly automate it. We ended up choosing conventional commits as a format to help streamline changelog generation process.

Here's the current shape of the convention

  • We allow 2 type fix and feat
  • Always add the scope, and the only supported scope now is sdk
  • Breaking change notation ! has been discussed yet. So there's no enforcing it now.
  • Add a conventional commit message in either
    • PR title: This will be included as the squash commit message to master
    • Each commit message: normally when squash merging GH will combine all commit message, so I could grab message from that

Milestone 1

Tasks

  1. .Team/Embedding
    WiNloSt
  2. WiNloSt
@WiNloSt WiNloSt added .CI & Tests .Epic Feature Implementation or Project Embedding/SDK Embedding SDK for React labels May 16, 2024
@WiNloSt WiNloSt self-assigned this May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.CI & Tests Embedding/SDK Embedding SDK for React .Epic Feature Implementation or Project
Projects
None yet
Development

No branches or pull requests

1 participant