README.md

Issues

What are issues? https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues

Purpose

This directory houses information about GitHub Issues.

Resources to explore

GitHub Issues Tips and Guidelines 15 minute YouTube video.

See the Bonus: Issue templates for your project section of this 2023 Axolo GitHub pull request template article.

Of note, an automated comment for each issue. See https://github.com/forem/forem/blob/main/.github/workflows/issue.yml

From Digital Knowledge Base

General Info

collapsed:: true

Look up how to properly (best practice) link a file to an issue.

See

• reference a commit in an issue

  https://stackoverflow.com/a/8910323

• Documentation

  • https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues

  • https://docs.github.com/en/issues/tracking-your-work-with-issues/quickstart

  • Different ways to create an issue:

  • Creating an issue

    Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow.

  • Issues documentation

    Overview and quickstart buttons

  • Autolinked references and URLs

    References to URLs, issues, pull requests, and commits are automatically shortened and converted into links.

  • Tracking your work with issues

    Use GitHub Issues to track ideas and work on GitHub

{{video(https://www.youtube.com/watch?v=DuAyYsWbt5o)}}

Github issues in a nutshell: {{video(https://www.youtube.com/watch?v=TKJ4RdhyB5Y)}}

Best Practices

• Not read yet:
  • https://rewind.com/blog/best-practices-for-using-github-issues/

Tips And Tricks

• There's something with fixes #_ that closes out the issue.

Documentation

https://docs.github.com/en/issues/guides

Directories and Files

Directories

issue_templates/

This directory houses information about Issue Templates.

Files

README.md

This readme file.