Skip to content

Commit 6d5a3ee

Browse files
Convert inline links to reference format, update navigation, use alert syntax for tip
1 parent 8f579d6 commit 6d5a3ee

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

content/full-day/2-issues.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Project management with GitHub Issues
22

3+
| [← Securing the development pipeline][walkthrough-previous] | [Next: Cloud-based development with GitHub Codespaces →][walkthrough-next] |
4+
|:-----------------------------------|------------------------------------------:|
5+
36
"URL or it didn't happen" is a common mantra at GitHub, which is used to highlight the importance of documenting the development process. Feature requests should have a history; who made the request, what was the rationale, who was involved in the process, what decisions were made, why were they made, was the feature implemented, how was it implemented... All of this information helps provide context to both drive future decisions and avoid repeating old mistakes.
47

5-
GitHub provides various features to enable collaboration and project management, including [GitHub Discussions](https://github.com/features/discussions), [wikis](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis), [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) and [GitHub Issues](https://github.com/features/issues). Each of these can help your organization drive the creation process. We're going to focus on GitHub Issues, which is the foundation of project management on GitHub.
8+
GitHub provides various features to enable collaboration and project management, including [GitHub Discussions][discussions], [wikis][wikis], [pull requests][about-prs] and [GitHub Issues][issues]. Each of these can help your organization drive the creation process. We're going to focus on GitHub Issues, which is the foundation of project management on GitHub.
69

710
At their core, issues document some form of an action. They can be a request for a feature, a bug report, or another operation taken by the team. There's no prescribed methodology for using GitHub Issues, allowing your team to determine the best way to manage and drive your projects. A common flow teams will implement on issues is:
811

@@ -33,16 +36,26 @@ Our project needs two main updates. We want to make the updates to support devel
3336
| Implement testing | Create a workflow to automate testing for continuous integration |
3437
| Add filters to dog list | Add the code to allow users to filter for dogs by breed and availability |
3538

36-
> **TIP:** You can also save an issue by pressing <kbd>Ctl</kbd> - <kbd>Enter</kbd> (or <kbd>Cmd</kbd> - <kbd>Return</kbd> on a Mac) in the title or description fields.
39+
> [!TIP]
40+
> You can also save an issue by pressing <kbd>Ctl</kbd> - <kbd>Enter</kbd> (or <kbd>Cmd</kbd> - <kbd>Return</kbd> on a Mac) in the title or description fields.
3741
3842
You've now defined all the issues for the workshop! You'll use these issues to help guide your progress through the workshop.
3943

4044
## Summary and next steps
41-
42-
GitHub Issues are the core to project management on GitHub. Their flexibility allows your organization to determine the best course of action to support your development lifecycle's methodology. With your issues created, it's time to turn your attention to the first big change to the project, [defining a codespace](3-codespaces.md).
45+
GitHub Issues are the core to project management on GitHub. Their flexibility allows your organization to determine the best course of action to support your development lifecycle's methodology. With your issues created, it's time to turn your attention to the first big change to the project, [defining a codespace][walkthrough-next].
4346

4447
## Resources
45-
46-
- [GitHub Issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues)
47-
- [Communicate using markdown](https://github.com/skills/communicate-using-markdown)
48-
- [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects)
48+
- [GitHub Issues][issues-docs]
49+
- [Communicate using markdown][skills-markdown]
50+
- [GitHub Projects][projects-docs]
51+
52+
| [← Securing the development pipeline][walkthrough-previous] | [Next: Cloud-based development with GitHub Codespaces →][walkthrough-next] |
53+
|:-----------------------------------|------------------------------------------:|
54+
55+
[discussions]: https://github.com/features/discussions
56+
[wikis]: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
57+
[about-prs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
58+
[issues]: https://github.com/features/issues
59+
[issues-docs]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
60+
[skills-markdown]: https://github.com/skills/communicate-using-markdown
61+
[walkthrough-next]: 3-codespaces.md[walkthrough-previous]: 1-code-scanning.md[projects-docs]: https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects

0 commit comments

Comments
 (0)