Update README.md

README.md

@@ -352,4 +352,122 @@ tags:
 pretty_name: HF Datasets GitHub issues
 size_categories:
 - n<1K
----
+---
+
+## Dataset Card for HF GitHub Dataset Issues with Comments
+
+### Table of Contents
+- [Dataset Description](#dataset-description)
+- [Dataset Summary](#dataset-summary)
+- [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+- [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+- [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+- [Source Data](#source-data)
+- [Annotations](#annotations)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+- [Additional Information](#additional-information)
+
+---
+
+### Dataset Description
+
+#### Dataset Summary
+This dataset consists of GitHub issues with their associated comments, providing insight into discussions and problem-solving processes in open-source development. Each issue entry includes metadata, such as issue title, description, labels, timestamps, and a series of comments with author information and timestamps. This dataset is valuable for studying code review, bug tracking, community dynamics, and language modeling tasks involving conversational threads.
+
+#### Supported Tasks and Leaderboards
+- **Text Classification**: Classify issues and comments by topic or label, e.g., "bug," "feature request."
+- **Sentiment Analysis**: Determine the sentiment of issue comments to gauge user satisfaction or frustration.
+- **Named Entity Recognition (NER)**: Identify technical terms, libraries, or code references within issue descriptions and comments.
+- **Summarization**: Generate summaries of discussions for quick context on complex threads.
+
+#### Languages
+Primarily **English (en)**, as GitHub is predominantly English-based, though some issues may contain multilingual comments.
+
+---
+
+### Dataset Structure
+
+#### Data Fields
+- **issue_id**: Unique identifier for each GitHub issue.
+- **title**: The title of the GitHub issue.
+- **description**: Detailed description of the issue.
+- **labels**: Labels associated with the issue (e.g., bug, enhancement).
+- **created_at**: Timestamp when the issue was created.
+- **closed_at**: Timestamp when the issue was closed (if applicable).
+- **comments**: List of comments, each including:
+  - **comment_id**: Unique identifier for each comment.
+  - **comment_body**: Text content of the comment.
+  - **comment_author**: Username of the comment author.
+  - **comment_created_at**: Timestamp when the comment was created.
+
+#### Example
+```
+{
+  "issue_id": "12345",
+  "title": "Error when running setup",
+  "description": "Steps to reproduce...",
+  "labels": ["bug", "setup"],
+  "created_at": "2022-08-01T12:34:56Z",
+  "closed_at": null,
+  "comments": [
+    {
+      "comment_id": "c1",
+      "comment_body": "I faced the same issue...",
+      "comment_author": "user123",
+      "comment_created_at": "2022-08-01T13:00:00Z"
+    },
+    ...
+  ]
+}
+```
+
+#### Data Splits
+This dataset may be split into **training**, **validation**, and **test** subsets based on issue ID, or by date ranges, to prevent data leakage between related issues or comments.
+
+---
+
+### Dataset Creation
+
+#### Curation Rationale
+The dataset was created to support research and practical applications in software engineering, natural language processing, and community analysis. By aggregating issue discussions, we can better understand the collaborative problem-solving dynamics on GitHub.
+
+#### Source Data
+- **Source**: Data is sourced from public GitHub repositories.
+- **License**: Open data sourced from GitHub’s API under GitHub’s [terms of service](https://docs.github.com/en/github/site-policy/github-terms-of-service).
+
+#### Annotations
+- **Annotation Process**: No manual annotation; data fields are collected directly from GitHub issues and comments.
+- **Annotation Statistics**: Automatically gathered metadata (e.g., labels, timestamps, user comments).
+
+---
+
+### Considerations for Using the Data
+
+#### Social Impact of Dataset
+This dataset aids in improving tools for open-source development and understanding community dynamics. However, comments may include sensitive discussions, which should be handled with privacy considerations.
+
+#### Dataset Limitations
+Some repositories may have data inconsistencies or missing fields, as issues and comments vary significantly in detail and style.
+
+#### Ethical Considerations
+Since comments are authored by individual users, avoid any misuse that could lead to user profiling or invasion of privacy. Consider GitHub’s data policies when redistributing or sharing this dataset.
+
+---
+
+### Additional Information
+
+#### Citation
+Please cite this dataset as follows:
+```
+@dataset{hf_github_issues_comments,
+  title = {HF GitHub Dataset Issues with Comments},
+  author = {Raibek Tussupbekov},
+  year = {2024},
+  url = {https://huggingface.co/datasets/hf_github_issues_comments}
+}
+```
+
+#### Contributions
+Data collection by Raibek Tussupbekov. Special thanks to contributors who maintain public GitHub repositories, making this dataset possible.