How to Use Jam

Getting started with Jam

With Jam, you can streamline your bug reporting process, allowing you to focus more on coding and less on documentation. After reading this guide, you'll be able to generate comprehensive bug reports with just a click.

Step 1: Sign up and set up

1. Go to jam.dev.
2. Click on the "Get Started" button on the homepage.
3. Choose your preferred sign-up method (Google, GitHub, or email).
4. Follow the prompts to create your account. If you opt for the free tier, you'll still have access to basic bug reporting features.

Step 2: Your first bug report

1. Once logged in, navigate to your project dashboard.
2. Start your application or website where you suspect a bug exists.
3. When you encounter a bug, click the "Report Bug" button located in the Jam browser extension or the web app.
4. Jam will automatically gather relevant data such as logs, network requests, and system specs.
5. Review the generated report for accuracy and completeness, then click "Submit" to send it to your issue tracker (like GitHub or Jira).

Step 3: Get better results

1. To enhance report quality, ensure your project settings are configured. Click on "Settings" in the dashboard and verify that your environment variables are correctly set.
2. Use descriptive labels and tags when submitting bugs to make them easily searchable.
3. Regularly check the "Insights" tab to monitor patterns in bugs reported, which can help you identify recurring issues.

Pro tip

Enable the "Auto Capture" feature in the settings. This will allow Jam to automatically gather data in the background, so you don’t have to click the button every time you encounter a bug.

Common mistake to avoid

Avoid submitting reports without reviewing them first. Jam can generate a lot of data, and failing to check for accuracy may lead to irrelevant or unclear reports, making it harder for your team to address the issues effectively.