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

should we use conventional commits? #111

Open
will opened this issue Apr 12, 2023 · 1 comment
Open

should we use conventional commits? #111

will opened this issue Apr 12, 2023 · 1 comment

Comments

@will
Copy link
Collaborator

will commented Apr 12, 2023

@abrightwell @ngaumont I saw a pr comment go through earlier today talking about the changelog, and it reminded me that I've been seeing a lot of projects out there starting more and more to use "Conventional Commits"

Detailed info is at https://www.conventionalcommits.org/en/v1.0.0/ (french version), but the short of it is having all commits have a prefix like feat or docs or chore. From there you can auto generate changelogs.

This tool, I've never used but it seems like it could do a decent job https://convco.github.io/ . It's in nixpkgs so it's easy to add to the dev shell.

--git a/flake.nix b/flake.nix
index 84c6656..d306de3 100644
--- a/flake.nix
+++ b/flake.nix
@@ -36,6 +36,7 @@
         };
 
         devShells.default = pkgs.mkShell {
+          packages = with pkgs; [ convco ];
           buildInputs = [ crystal pkgs.libssh2 c2n ];
         };
 

And also I could see having a GitHub action that takes care of doing the changelog whenever something is merged into main.

@ngaumont
Copy link
Contributor

I used conventional commit in my previous company, and we also code our own changelog generator (here but not useable as mercurial based). So, I'm definitely in to use it :)

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

No branches or pull requests

2 participants