Prompt or config for auto generated commits #26503

eulke · 2025-03-12T02:13:28Z

eulke
Mar 12, 2025

Is there any way to configure or give instructions on how i need the generated messages to be? I have a project with an automated changelog based on commits with conventional format, it would be nice to tell zed to use that format on auto generated commits

nithinbull · 2025-03-13T06:40:21Z

nithinbull
Mar 13, 2025

Yes It would be nice to have some amount of customisation to guide the model to generate messages with a specific format. Like say, "add the <branch_name | name | date> as header and number the commit messages"

0 replies

0x2CA · 2025-03-13T07:41:11Z

0x2CA
Mar 13, 2025

Not so good now, because it's hardcoded

                let mut diff_text = diff.await??;

                const ONE_MB: usize = 1_000_000;
                if diff_text.len() > ONE_MB {
                    diff_text = diff_text.chars().take(ONE_MB).collect()
                }

                let subject = this.update(&mut cx, |this, cx| {
                    this.commit_editor.read(cx).text(cx).lines().next().map(ToOwned::to_owned).unwrap_or_default()
                })?;

                let text_empty = subject.trim().is_empty();

                let content = if text_empty {
                    format!("{PROMPT}\nHere are the changes in this commit:\n{diff_text}")
                } else {
                    format!("{PROMPT}\nHere is the user's subject line:\n{subject}\nHere are the changes in this commit:\n{diff_text}\n")
                };

                const PROMPT: &str = include_str!("commit_message_prompt.txt");

                let request = LanguageModelRequest {
                    messages: vec![LanguageModelRequestMessage {
                        role: Role::User,
                        content: vec![content.into()],
                        cache: false,
                    }],
                    tools: Vec::new(),
                    stop: Vec::new(),
                    temperature: None,
                };

commit_message_prompt.txt

You are an expert at writing Git commits. Your job is to write a short clear commit message that summarizes the changes.

If you can accurately express the change in just the subject line, don't include anything in the message body. Only use the body when it is providing *useful* information.

Don't repeat information from the subject line in the message body.

Only return the commit message in your response. Do not include any additional meta-commentary about the task. Do not include the raw diff output in the commit message.

Follow good Git style:

- Separate the subject from the body with a blank line
- Try to limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with any punctuation
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Keep the body short and concise (omit it entirely if not useful)

2 replies

nithinbull Mar 13, 2025

So the subject line is still preserved after the auto generation, that's convenient. But to have a new commit_message_prompt.txt prompt, should the editor be rebuilt?

0x2CA Mar 13, 2025

So the subject line is still preserved after the auto generation, that's convenient. But to have a new commit_message_prompt.txt prompt, should the editor be rebuilt?

Yes, that's the way it is now.

rprasquier-pass · 2025-03-20T14:54:18Z

rprasquier-pass
Mar 20, 2025

Being able to customize the prompt would allow some specific git commit message specification like gitmoji / conventional commits / etc.

0 replies

Lersoo · 2025-03-28T14:26:46Z

Lersoo
Mar 28, 2025

This seems simple enough to update :

add a setting in the git_panel_settings crate
in the git_panel crate, replace the hard-coded PROMPT value with either the setting introduced beforehand, or the default value. something like :

const PROMPT: &str = GitPanelSettings::get_global(cx)
            .git_commit_prompt
            .unwrap_or(include_str!("commit_message_prompt.txt");

I'm not too sure about the syntax as I'm definitely not a Rust expert, but if that sounds like something you guys would like to see implemented, I'll be more than happy to try to work on a PR 🙂

0 replies

tashi21 · 2025-04-24T07:54:18Z

tashi21
Apr 24, 2025

I agree!

The feature to generate a commit message using AI is superb! I use it quite a lot. In most cases, the message is constructed quite well.

One thing that I feel is missing is that there is no way for me to tell the AI the format and structure of the commit message. Just like how I can interact with the Assistant Panel and define custom prompts, there should be a way to add a prompt for how the commit needs to be generated and what to consider.

1 reply

rafmst Apr 24, 2025

Yes, for example generating the commit message in following conventional commits format

nelwincatalogo · 2025-05-06T07:45:36Z

nelwincatalogo
May 6, 2025

it would be nice if we can attach a rule in Generate Commit Message from Rules Library

1 reply

raphaelluethy Sep 1, 2025

it would be nice if we can attach a rule in Generate Commit Message from Rules Library

I think the integration of the rules library would be amazing, maybe this could live as a setting so that it doesnt clutter the ui? Or maybe add it as a setting first and if the team has time they could do the design work?

I would be happy to have a shot at it!