Skip to main content
All CollectionsTutorials
Commenting on an Item via Commit Message
Commenting on an Item via Commit Message
Wade Williams avatar
Written by Wade Williams
Updated over a week ago

Introduction

If you have enabled our GitHub, Beanstalk, or bitbucket integration, or configured your on-premise SCM server to send post-commit data to Sprint.ly, you can manipulate tickets from commit messages. When Sprint.ly sees a commit that says "Refs #55" or "See #55" (where #55 is the item number), it will do two things:

  1. Attach your commit message as a comment.

  2. Send an email notification to everyone on the team regarding your commit.

Note: We have a more detailed overview of our SCM command syntax that explains all of the possible commands and syntaxes available.

Creating a comment via a commit message

When you commit your code, you'll want to use the proper syntax. The shortest options are "Refs #44", "Re #44", and "See #44". Below is an example.

Tip: Since these messages end up as emails in your coworkers' inboxes, and they can reply to those via email, you can treat commit messages as comments to your coworkers. It's a great way to ask questions without having to leave your terminal.

Where can I get the item number?

An item's number is always in the lower left of the item card.

Tip: You can use the Git pre-commit hook for finding item numbers from the comfort of your terminal.

How long does it normally take to show up on Sprint.ly?

This depends on a number of factors, but a commit will usually get pushed to Sprint.ly within 60 seconds. If your commits appear to be ignored, the most common reason for this is that the email address used by the committer doesn't match up with your Sprint.ly user account.

Where do my commits go?

Your commits show up on the items referenced as comments. Additionally, your commit messages are pushed to that item's team via email and will show up in the daily digest.

Note: They link back to the individual commit and the repository where the commit was pushed to.

Did this answer your question?