Skip to main content
Practice

1

deck​

What are Issues?​

Issues are used in the following situations:

  • Bug reporting
  • Proposing new features
  • Discussing improvements

Tips for Writing Issue Titles​

A good issue title should convey the main point concisely and clearly, using tags to give hints about the content.

Examples:

  • [Bug] Cannot submit form on mobile
  • [Feature] Add dark mode support
  • [Refactor] Simplify auth logic

The issue content should be predictable just from the title alone.

===

What is an Issue Template?​

An issue template is a pre-defined document that specifies the format for writing issues. It is stored in the following location:

.github/ISSUE_TEMPLATE/

It typically falls into two categories:

  1. Bug Report
  2. Feature Request

===

Bug Report Template Example​

## Describe the bug
A clear and concise description of what the bug is.

## Steps to reproduce
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## Expected behavior
What you expected to happen.

## Screenshots
If applicable, add screenshots to help explain your problem.

===

Feature Request Template Example​

## Describe the feature
A clear and concise description of what you want to happen.

## Motivation
Why is this feature important or useful?

## Alternatives
Have you considered other solutions?

## Additional context
Add any other context or screenshots about the feature request here.

===

Want to learn more?

Join CodeFriends Plus membership or enroll in a course to start your journey.