Skip to content

Suggest better commit message #14

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

Merged
jackbackes merged 3 commits into from
Apr 18, 2023
Merged

Suggest better commit message #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
060a6c2
Change file permissions for add-openai-api-key.sh
jackbackes Apr 18, 2023
e05c753
Add HappyCommit message to commit message
jackbackes Apr 18, 2023
679f0a1
Improve commit message format in response to feedback
jackbackes Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified add-openai-api-key.sh
100644 → 100755
View file
Open in desktop
Empty file.
62 changes: 44 additions & 18 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,30 +135,42 @@ END FORMAT
Instructions:

You can use the following guidelines to help them write a good commit message:

Write a concise and informative subject line: The subject line should summarize the change in 50 characters or less. It should be written in the imperative mood (e.g., \"Add feature X\" rather than \"Added feature X\").

Separate subject from body with a blank line: If you need to provide more context, include a message body after a blank line. This helps separate the summary from the details.

Explain the \"what\" and \"why\" in the message body: The message body should provide context on why the change was made and any potential implications. Avoid focusing on the \"how\" since that can be deduced from the code itself.

Use proper grammar, spelling, and punctuation: Good commit messages are well-written and easy to understand. Proper language usage helps convey the meaning effectively.

Keep line lengths reasonable: Aim for a maximum of 72 characters per line in the message body to ensure readability across different devices and tools.

Use bullet points or lists for multiple changes: If the commit contains several changes, organize them using bullet points or numbered lists for better readability.

Avoid generic or ambiguous messages: Commit messages like \"bug fix\" or \"updates\" don't provide enough context. Be specific about the changes you've made.

Don't include code in the message: The commit message should describe the change, not include the code itself. If the change is too complex to describe succinctly, consider breaking it into smaller commits.

Proofread before committing: Double-check your commit message for clarity, accuracy, and completeness before submitting it.

Organize the commit message to include any testing done: If you have tested the code, include the results in the commit message. If you have not tested the code, include a note that you have not tested the code.

Humor is ok, but don't overdo it. :wink:

All of the provided code is from a single staged workspace.";
Note: All of the provided code is from a single staged workspace.
=====
Good Output:
Branch: <suggested branch name>
~~~~~~~~~~
Subject: <subject (50 chars or less)>
~~~~~~~~~~
Body: <body>
=====
Bad Output (explaining the format):
Let me help you write a good commit message. First...
=====
Bad Output (giving advice):
Here are some ways you could improve your commit message.
=====
Bad Output (repeating the template):
This is a new feature that does something really cool.
- cool thing 1
- cool thing 2
=====
Bad Output (restating instructions):
Use proper grammar, spelling, and punctuation: Good commit messages are well-written and easy to understand. Proper language usage helps convey the meaning effectively.
=====
Bad Output: Making things up that aren't in the diff.
";

fn create_message(message: ChatMessage) -> async_openai::types::ChatCompletionRequestMessage {
async_openai::types::ChatCompletionRequestMessage {
Expand Down Expand Up @@ -339,7 +351,9 @@ async fn main() {
- cool thing 1
- cool thing 2

Output: feature/1234
Good Output: feature/1234
Bad Output: \"feature/1234\"
Bad Output: \"Branch: feature/1234\"
```

Example 2:
Expand All @@ -354,7 +368,9 @@ async fn main() {
- cool thing 1
- cool thing 2

Output: \"Add a new feature\"
Good Output: Add a new feature
Bad Output: \"Add a new feature\"
Bad Output: \"Subject: Add a new feature\"
```

Example 3:
Expand All @@ -369,9 +385,11 @@ async fn main() {
- cool thing 1
- cool thing 2

Output: \"This is a new feature that does something really cool.
Good Output: This is a new feature that does something really cool.
- cool thing 1
- cool thing 2\"
- cool thing 2
Bad Output: \"This is a new feature that does something really cool.\"
Bad Output: \"Body: This is a new feature that does something really cool.\"
```".to_string()),
("CommitMessageProvider".to_string(), async_openai::types::Role::Assistant, final_message.to_string()),
("User".to_string(), async_openai::types::Role::User, format!("Provide {} for commit message ^", query)),
Expand Down Expand Up @@ -399,7 +417,15 @@ async fn main() {
.await
.unwrap();

let commit_message = format!("{}\n\n{}", subject, body);
let commit_message = format!("{}


{}

~~~~~~~~~~
This commit message was generated by HappyCommit. Try it in your project today!
Check it out at https://github.com/jackbackes/happycommit
", subject, body);

let mut commit_file = tempfile::NamedTempFile::new().expect("Failed to create temporary file");
commit_message.split('\n').for_each(|line| {
Expand Down