Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit fa66b1e

Browse files
committed
repurpose to a tutorial guide
1 parent 2c326fe commit fa66b1e

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

content/issues/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ featuredLinks:
1414
guideCards:
1515
- /issues/trying-out-the-new-projects-experience/automating-projects
1616
- /issues/tracking-your-work-with-issues/creating-issues/linking-a-pull-request-to-an-issue
17+
- /issues/tracking-your-work-with-issues/managing-a-cross-functional-team-or-project-on-github
1718
- /issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards
1819
popular:
1920
- /issues/tracking-your-work-with-issues/creating-issues/about-issues

content/issues/quickstart.md renamed to content/issues/tracking-your-work-with-issues/managing-a-cross-functional-team-or-project-on-github.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Quickstart for GitHub Issues
3-
intro: "The essentials for getting started with {% data variables.product.prodname_dotcom %}'s planning and tracking tools."
2+
title: Managing a cross-functional team or project on GitHub
3+
intro: "The essentials for using {% data variables.product.prodname_dotcom %}'s planning and tracking tools to manage work on a team or project."
44
allowTitleToDifferFromFilename: true
55
versions:
66
free-pro-team: '*'
77
enterprise-server: '*'
88
github-ae: '*'
99
---
1010
## Introduction
11-
You can use {% data variables.product.prodname_dotcom %} repositories, issues, project boards, and other tools to plan and track your work, whether working on an individual project or large initiative.
11+
You can use {% data variables.product.prodname_dotcom %} repositories, issues, project boards, and other tools to plan and track your work, whether working on an individual project or cross-functional team.
1212

13-
In this guide, you will learn how to create and set up a repository for collaborating with a team, create issue templates{% if currentVersion == "free-pro-team@latest" %} and forms{% endif %}, open issues and use task lists to break down work, and establish a project board for organizing and tracking issues.
13+
In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates{% if currentVersion == "free-pro-team@latest" %} and forms{% endif %}, open issues and use task lists to break down work, and establish a project board for organizing and tracking issues.
1414

1515
## Creating a repository
1616
When starting a new project, initiative, or feature, the first step is to create a repository. Repositories contain all of your project's files and give you a place to collaborate with others and manage your work. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)."
@@ -30,12 +30,12 @@ You can create a README.md file for your repository to introduce your team or pr
3030

3131
You can also create a CONTRIBUTING.md file specifically to contain guidelines on how users or contributors can contribute and interact with the team or project, such as how to open a bug fix issue or request an improvement. For more information, see "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
3232
### README example
33-
Here is an example of a README.md created for our newly created project, Project Octocat.
33+
We can create a README.md to introduce our new project, Project Octocat.
3434

3535
![Creating README example](/assets/images/help/issues/quickstart-creating-readme.png)
3636
## Creating issue templates
3737

38-
You can use issues to track the different types of work that your team or project covers, as well as gather information from those outside of your project. The following are a few common use cases for issues.
38+
You can use issues to track the different types of work that your cross-functional team or project covers, as well as gather information from those outside of your project. The following are a few common use cases for issues.
3939

4040
- Release tracking: You can use an issue to track the progress for a release or the steps to complete the day of a launch.
4141
- Large initiatives: You can use an issue to track progress on a large initiative or project, which is then linked to the smaller issues.
@@ -49,14 +49,14 @@ Below we are creating an issue template for reporting a bug in Project Octocat.
4949

5050
![Creating issue template example](/assets/images/help/issues/quickstart-creating-issue-template.png)
5151

52-
Now that we created the bug report issue template, you are able to choose it when creating a new issue in Project Octocat.
52+
Now that we created the bug report issue template, you are able to select it when creating a new issue in Project Octocat.
5353

5454
![Choosing issue template example](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png)
5555

5656
## Opening issues and using task lists to track work
5757
You can organize and track your work by creating issues. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-issues/creating-an-issue)."
5858
### Issue example
59-
Here is an example of an issue created for a large initiative in Project Octocat.
59+
Here is an example of an issue created for a large initiative, front-end work, in Project Octocat.
6060

6161
![Creating large initiative issue example](/assets/images/help/issues/quickstart-create-large-initiative-issue.png)
6262
### Task list example
@@ -70,7 +70,7 @@ Below we have added a task list to our Project Octocat issue, breaking it down i
7070
## Making decisions as a team
7171
You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[Which discussion tool should I use?](/github/getting-started-with-github/quickstart/communicating-on-github#which-discussion-tool-should-i-use)."
7272

73-
As a team, you can also communicate updates on day-to-day tasks within issues so that everyone knows the status of work. For example, you can create an issue for a large feature that multiple people are working on, and each team member can add updates with their status or open questions in that issue.
73+
As a team, you can also communicate updates on day-to-day tasks within issues so that everyone knows the status of work. For example, you can create an issue for a large feature that multiple people are working on, and each team member can add updates with their status or open questions in that issue.
7474
### Issue example with project collaborators
7575
Here is an example of project collaborators giving a status update on their work on the Project Octocat issue.
7676

@@ -80,9 +80,9 @@ You can create labels for a repository to categorize issues, pull requests, and
8080

8181
For more information, see "[Creating a label](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)."
8282

83-
Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label. For more information, see "[Filtering issues and pull requests by labels](/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels)."
83+
Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering issues and pull requests by labels](/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels)."
8484
### Label example
85-
Below is an example of a `front-end` label that we created and added to the issue.
85+
Below is an example of a `front-end` label that we created and added to the issue.
8686

8787
![Adding a label to an issue example](/assets/images/help/issues/quickstart-add-label-to-issue.png)
8888
## Adding issues to a project board
@@ -103,10 +103,9 @@ You can {% if currentVersion == "free-pro-team@latest" %} also use the existing{
103103
Below is a project board for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it.
104104

105105
![Project board example](/assets/images/help/issues/quickstart-project-board.png)
106-
107106
## Next steps
108107

109-
You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your team or project repository! Here are some helpful resources for further customizing your repository and organizing your work.
108+
You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your cross-functional team or project repository! Here are some helpful resources for further customizing your repository and organizing your work.
110109

111110
- "[About repositories](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories)" for learning more about creating repositories
112111
- "[Tracking your work with issues](/issues/tracking-your-work-with-issues)" for learning more about different ways to create and manage issues

0 commit comments

Comments
 (0)