GitHub Projects and Issue Management Flashcards

What is GitHub Discussions primarily designed for compared to GitHub Issues?

Answer: Discussions are for open-ended conversations, Q&A, and announcements; Issues are for actionable tasks and bugs

GitHub Discussions hosts community conversations, Q&A, and announcements that don't require a trackable work item, while Issues are reserved for actionable bugs and tasks.

Which GitHub feature allows you to automate project workflows such as automatically moving items when a pull request is opened?

Answer: GitHub Projects built-in automation (workflow automations)

GitHub Projects includes built-in workflow automation rules that can automatically set item status (e.g., move to 'In Progress') when issues or PRs change state.

When an issue is referenced with '#' followed by its number in a commit message, what happens on GitHub?

Answer: GitHub creates a cross-reference link between the commit and the issue

Mentioning an issue number with '#' in a commit message creates a cross-reference link in the issue timeline, providing traceability between code changes and the issue.

What is the recommended way to handle a long-running GitHub Issue that spans multiple pull requests?

Answer: Use a tracking issue with a task list (checklist) that references related sub-issues or PRs

A tracking issue with a task list (using `- [ ]` checkboxes linked to sub-issues or PRs) provides a high-level overview of a large feature or epic across multiple contributions.

What does the 'good first issue' label signal to potential contributors?

Answer: The issue is well-scoped and suitable for contributors new to the project

The 'good first issue' label is a widely-used convention to help new contributors find approachable entry points into an open-source project.

How does linking a GitHub Issue to a pull request benefit the development workflow?

Answer: It provides traceability between the reported problem and the code change that resolves it, and can auto-close the issue on merge

Linking issues to pull requests creates a traceable connection between the problem and its fix, and using closing keywords will automatically close the issue when the PR is merged.