generated from datatrail-jhu/DataTrail_Template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
06_sharing_results_07_issues.Rmd
38 lines (18 loc) · 2.67 KB
/
06_sharing_results_07_issues.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
```{r, include = FALSE}
ottrpal::set_knitr_image_path()
```
# Organization with Issues on GitHub
We've covered the basics of how to set up a repository for a project and synchronize changes between local and remote versions of the repository. In this lesson, we will introduce a tool called Issues on GitHub that is useful for organization and communication within a project.
### What are Issues?
Issues are essentially a task system that come with GitHub repositories. They allow specification of a certain task or item to complete and have discussion threads, assigned workers, and labels. They are a convenient way to stay organized and communicate with others involved in or interested in your project.
### Creating an Issue
First navigate to the Issues tab on the main repository webpage.
Then click the green button that says "New issue."
On the resulting page, there are forms that allow you to type a concise description of the task and a more detailed description. This description could be used to elaborate specific steps that are needed to fulfill this task. There are also options on the right that allow you to assign GitHub users to work on this issue. On the right hand side, you can also assign labels to an issue. This can be useful if your project has many issues, and you later want to view only certain ones.
After you create this issue, you will be taken to the webpage for your issue which contains a discussion thread. You can use this to communicate with others about the status of this task. When the task is complete, you can close the issue to mark it as resolved.
Over the course of the project, you can come back to the Issues tab on your repository webpage to view the status of different tasks.
