<aside> 💡 A quick start guide for those who are brand new to AutoCommit.AI

</aside>

This guide is meant to help you get started with AutoCommit.AI as quickly as possible. By the end of the guide, you will have:

• installed the AutoCommit.AI VSCode extension
• connected your Jira account with your AutoCommit.AI account
• connected your Github account with your AutoCommit.AI account
• generated and published your first AutoCommit.AI commit message

Prerequisites

In order to get started, you will need the following:

• a VSCode Account
• The ability to connect your Github Account
• The ability to connect to your Jira account

Getting Started

Step 1: Install the AutoCommit.AI VSCode Extension

Step 2: Sign up for an AutoCommit.AI account to connect your Github and Jira accounts with AutoCommit.AI. You can use your gmail account, Jira account, Github account, or email to sign up.

Step 3: Connect your Jira and Github Accounts. You can connect your Jira and Github accounts that are associated with a different email than the one you used to sign up.

Step 4: Confirm your settings. By default, AutoCommit.AI will copy your generated commit and pull request messages to the associated Jira Ticket.

Step 5: Return to your VSCode editor. Once you’re ready to commit, you can either use the UI or git commands in your terminal within VSCode to commit. Once you hit our AutoCommit button or commit within the VSCode terminal, we’ll prompt you to choose a Jira ticket (which you can skip) and tell us what kind of change it is. From there we’ll draft a commit message title and body for you. Edit as you see fit and hit enter. The commit will commit as normal to Github. If you’ve enabled Jira commenting in your settings, we’ll automatically post a comment with the commit title in the Jira ticket.