Suggested format for reporting bugs during CodeLab sessions

[markweldensmith]

---

🐛 Bug Report Steps

1. Complete the details below using the template
2. Via the side panel:

• Set the Type to 'bug'
• Set the label
• Assign task
• Select a related project

3. Create issue

---

🐛 Bug Description

A clear and concise description of what the bug is.

Example: “The app crashes when uploading .csv files larger than 50MB.”

---

✅ Expected Behavior

What should happen instead?

Example: “The file should upload and a confirmation message should appear.”

---

🚫 Actual Behavior

What is happening instead?

Example: “The app freezes and displays a memory error.”

---

🧩 Steps to Reproduce

1. Go to Upload page
2. Drag in a .csv file larger than 50MB
3. Wait ~10 seconds
4. Observe the crash or freeze

---

🖥️ Environment

• OS:
• Browser/Tool:
• App version/commit:
• Configuration:

---

📷 Screenshots / Logs / Attachments

Please provide any relevant screenshots, logs, or files.

Attachments can help us reproduce and fix the issue faster.

---

🔗 Related Issues / PRs

List any related issues or pull requests.

Example: #101, #223

---

🧪 Known Workarounds

Are there any temporary solutions?

Example: “Manually selecting files instead of using drag-and-drop.”

---

[markweldensmith]

Further information on steps that could be taken to set up templates that users can select when creating bugs, features, and tasks.

⸻

🧰 Using Prebuilt GitHub Issue Templates (for Bugs, Features, and Tasks)

GitHub allows you to create and use prebuilt issue templates for bug reports, feature requests, and tasks. This ensures consistency and saves time for your team when creating issues.

⸻

✅ How to Set Up Prebuilt Issue Templates

You can configure multiple issue templates by adding markdown files to a specific directory in your repository.

📁 Folder Structure

Create the following directory in your repository:

.github/ISSUE_TEMPLATE/

Inside that folder, create individual markdown files for each issue type:
• bug.md
• feature.md
• task.md

Each file begins with YAML frontmatter to define metadata like title, labels, and description.

⸻

✨ Example: feature.md

✨ Feature Description

A clear and concise description of what the feature is.

Problem / Motivation

What problem does this feature solve?

Proposed Solution

How would you like to see it implemented?

Alternatives Considered

Any alternative solutions you've thought about?

Additional Context

Add any context, diagrams, or examples.

⸻

📋 Optional: config.yml for Customization

To customize the issue creation experience (e.g., hiding blank issues), you can add a file called:

.github/ISSUE_TEMPLATE/config.yml

Example: config.yml

blank_issues_enabled: false
contact_links:

• name: 📖 Documentation
  url: https://your-docs-url.com
  about: Read the official documentation before submitting an issue.

⸻

🧪 Result

Once configured, when someone clicks “New issue” in your repo, GitHub will display a template chooser:
• 🐛 Bug
• ✨ Feature
• 📋 Task

⸻