Skip to main content

Issues

Issues are the primary way to report problems, request new features, or discuss potential changes before creating a pull request. They help us track work, prioritize tasks, and coordinate contributions.

Types of Issues​

🐛 Bug Reports​

Report problems with the documentation or website functionality.

Before creating a bug report:

  • Search existing issues to avoid duplicates
  • Check if the issue has been fixed in the latest version
  • Try to reproduce the issue

Bug report template:

## Bug Description
Brief description of the bug

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

## Expected Behavior
What you expected to happen

## Actual Behavior
What actually happened

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

## Environment
- OS: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
- Browser: [e.g. Chrome 91, Firefox 89, Safari 14]
- Node.js version: [e.g. 16.14.0]

## Additional Context
Add any other context about the problem here

✨ Feature Requests​

Suggest new features or improvements for the documentation.

Feature request template:

## Feature Description
Clear and concise description of the feature

## Problem Statement
What problem does this feature solve? Why is it needed?

## Proposed Solution
Describe your proposed solution

## Alternatives Considered
Describe any alternative solutions you've considered

## Additional Context
Add any other context, mockups, or examples about the feature request

📚 Documentation Improvements​

Request improvements to existing documentation or suggest new content.

Documentation issue template:

## Documentation Issue
Brief description of the documentation problem or improvement

## Current State
What is currently documented (or missing)

## Proposed Changes
What should be changed or added

## Target Audience
Who would benefit from this change

## Examples
Provide examples of the improved documentation if possible

Finding Issues to Work On​

Browse Existing Issues​

  1. Visit our Issues page

  2. Use labels to filter:

    • good first issue - Great for newcomers
    • help wanted - Community help needed
    • bug - Bug reports
    • enhancement - Feature requests
    • documentation - Documentation improvements

  3. Check issue status:

    • Open - Available to work on
    • Assigned - Someone is already working on it
    • In Progress - Work has started

Good First Issues​

Look for issues labeled good first issue - these are perfect for new contributors:

  • Small, well-defined tasks
  • Clear requirements
  • Good for learning the codebase
  • Usually documentation or minor fixes

Claiming an Issue​

  1. Comment on the issue expressing your interest
  2. Wait for maintainer approval before starting work
  3. Assign yourself if you have permission, or ask a maintainer to assign you
  4. Create a branch and start working

Creating High-Quality Issues​

Before Creating an Issue​

  1. Search thoroughly - Check if a similar issue already exists
  2. Use the search bar with relevant keywords
  3. Check closed issues - Your issue might have been resolved

Writing Effective Issues​

Title Guidelines:

  • Be specific and descriptive
  • Use action verbs when appropriate
  • Keep it concise but informative

Examples:

  • ❌ "Problem with docs"
  • ✅ "Fix broken link in installation guide"
  • ❌ "Add something"
  • ✅ "Add troubleshooting section for Windows users"

Description Guidelines:

  • Provide context - Explain the background
  • Be specific - Include exact steps, URLs, or code snippets
  • Include examples - Show what you mean
  • Add screenshots - Visual context is invaluable
  • Mention your environment - OS, browser, Node.js version

Issue Labels​

We use labels to categorize issues:

Type Labels:

  • bug - Something isn't working
  • enhancement - New feature or request
  • documentation - Documentation improvements
  • question - Further information is requested

Priority Labels:

  • priority: high - Critical issues
  • priority: medium - Important issues
  • priority: low - Nice to have

Status Labels:

  • good first issue - Good for newcomers
  • help wanted - Extra attention needed
  • duplicate - Issue already exists
  • wontfix - Will not be addressed

Issue Lifecycle​

  1. Created - Issue is opened
  2. Triage - Maintainers review and label
  3. Assigned - Someone takes ownership
  4. In Progress - Work has started
  5. Review - Solution is being reviewed
  6. Closed - Issue is resolved

Best Practices​

For Issue Creators​

  • Be patient - Maintainers are volunteers
  • Provide updates - Respond to questions promptly
  • Be respectful - Follow our code of conduct
  • Close issues - Mark as resolved when fixed

For Issue Contributors​

  • Ask questions - Clarify requirements before starting
  • Provide updates - Keep the issue updated with progress
  • Link PRs - Reference the issue in your pull request
  • Test thoroughly - Ensure your solution works

Getting Help​

If you need help with issues:

  • Check existing documentation first
  • Ask in the issue comments for clarification
  • Join community discussions for general questions
  • Contact maintainers for urgent issues

Remember: Good issues lead to better contributions and a stronger community! 🚀