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.

Sign up for GitHub

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

Jump to bottom

Force commit messages and smart changelog #709

Open
a1ttech opened this issue Oct 25, 2024 · 0 comments · May be fixed by #757
Open

Force commit messages and smart changelog #709

a1ttech opened this issue Oct 25, 2024 · 0 comments · May be fixed by #757
Labels
good first issue Good for newcomers Scout Game: Intermediate

Comments

@a1ttech
Copy link
Contributor

a1ttech commented Oct 25, 2024 •
edited
Loading

Problem

We currently update our versions and build our changelogs manually, which are a key piece of documentation for our migration and usage guides.

Considering the amount of devs, commits, PRs and projects (nx) this can be troublesome, and prone to forgetting key changes. Also, being an open source product allows anyone to contribute so we must enforce them to follow some rules to ease their contribution validation and incorporation.

Solution

Use a git hook to force developers to use a conventional commit message format and a PR requirement to have changelog documentation based on those.

Bonus: Use AI to pre-generate those messages.
Abuchtela added a commit to Abuchtela/js-sdk that referenced this issue Jan 3, 2025
@Abuchtela
Add git hooks to enforce conventional commit message format and chang…
3f9cd72 
…elog generation

Fixes LIT-Protocol#709

Add dependencies and scripts to enforce conventional commit message format and automate changelog generation.

* Add `commitlint`, `husky`, and `standard-version` dependencies to `package.json`.
* Add `commitlint` configuration to enforce conventional commit message format.
* Add a script to generate changelog automatically using `standard-version`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/LIT-Protocol/js-sdk/issues/709?shareId=XXXX-XXXX-XXXX-XXXX).
This was referenced Jan 3, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers Scout Game: Intermediate
Projects
None yet
Milestone
No milestone
1 participant
@a1ttech