Update README.md

README.md

@@ -1,367 +1,152 @@
 ---
-dataset_info:
-  features:
-  - name: url
-    dtype: string
-  - name: repository_url
-    dtype: string
-  - name: labels_url
-    dtype: string
-  - name: comments_url
-    dtype: string
-  - name: events_url
-    dtype: string
-  - name: html_url
-    dtype: string
-  - name: id
-    dtype: int64
-  - name: node_id
-    dtype: string
-  - name: number
-    dtype: int64
-  - name: title
-    dtype: string
-  - name: user
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: labels
-    list:
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: name
-      dtype: string
-    - name: color
-      dtype: string
-    - name: default
-      dtype: bool
-    - name: description
-      dtype: string
-  - name: state
-    dtype: string
-  - name: locked
-    dtype: bool
-  - name: assignees
-    list:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: milestone
-    struct:
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: labels_url
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: number
-      dtype: int64
-    - name: title
-      dtype: string
-    - name: description
-      dtype: string
-    - name: creator
-      struct:
-      - name: login
-        dtype: string
-      - name: id
-        dtype: int64
-      - name: node_id
-        dtype: string
-      - name: avatar_url
-        dtype: string
-      - name: gravatar_id
-        dtype: string
-      - name: url
-        dtype: string
-      - name: html_url
-        dtype: string
-      - name: followers_url
-        dtype: string
-      - name: following_url
-        dtype: string
-      - name: gists_url
-        dtype: string
-      - name: starred_url
-        dtype: string
-      - name: subscriptions_url
-        dtype: string
-      - name: organizations_url
-        dtype: string
-      - name: repos_url
-        dtype: string
-      - name: events_url
-        dtype: string
-      - name: received_events_url
-        dtype: string
-      - name: type
-        dtype: string
-      - name: user_view_type
-        dtype: string
-      - name: site_admin
-        dtype: bool
-    - name: open_issues
-      dtype: int64
-    - name: closed_issues
-      dtype: int64
-    - name: state
-      dtype: string
-    - name: created_at
-      dtype: timestamp[s]
-    - name: updated_at
-      dtype: timestamp[s]
-    - name: due_on
-      dtype: 'null'
-    - name: closed_at
-      dtype: 'null'
-  - name: comments
-    list: string
-  - name: created_at
-    dtype: timestamp[s]
-  - name: updated_at
-    dtype: timestamp[s]
-  - name: closed_at
-    dtype: timestamp[s]
-  - name: assignee
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: author_association
-    dtype: string
-  - name: type
-    dtype: 'null'
-  - name: active_lock_reason
-    dtype: 'null'
-  - name: draft
-    dtype: bool
-  - name: pull_request
-    struct:
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: diff_url
-      dtype: string
-    - name: patch_url
-      dtype: string
-    - name: merged_at
-      dtype: timestamp[s]
-  - name: body
-    dtype: string
-  - name: closed_by
-    struct:
-    - name: login
-      dtype: string
-    - name: id
-      dtype: int64
-    - name: node_id
-      dtype: string
-    - name: avatar_url
-      dtype: string
-    - name: gravatar_id
-      dtype: string
-    - name: url
-      dtype: string
-    - name: html_url
-      dtype: string
-    - name: followers_url
-      dtype: string
-    - name: following_url
-      dtype: string
-    - name: gists_url
-      dtype: string
-    - name: starred_url
-      dtype: string
-    - name: subscriptions_url
-      dtype: string
-    - name: organizations_url
-      dtype: string
-    - name: repos_url
-      dtype: string
-    - name: events_url
-      dtype: string
-    - name: received_events_url
-      dtype: string
-    - name: type
-      dtype: string
-    - name: user_view_type
-      dtype: string
-    - name: site_admin
-      dtype: bool
-  - name: reactions
-    struct:
-    - name: url
-      dtype: string
-    - name: total_count
-      dtype: int64
-    - name: '+1'
-      dtype: int64
-    - name: '-1'
-      dtype: int64
-    - name: laugh
-      dtype: int64
-    - name: hooray
-      dtype: int64
-    - name: confused
-      dtype: int64
-    - name: heart
-      dtype: int64
-    - name: rocket
-      dtype: int64
-    - name: eyes
-      dtype: int64
-  - name: timeline_url
-    dtype: string
-  - name: performed_via_github_app
-    dtype: 'null'
-  - name: state_reason
-    dtype: string
-  - name: sub_issues_summary
-    struct:
-    - name: total
-      dtype: int64
-    - name: completed
-      dtype: int64
-    - name: percent_completed
-      dtype: int64
-  - name: issue_dependencies_summary
-    struct:
-    - name: blocked_by
-      dtype: int64
-    - name: total_blocked_by
-      dtype: int64
-    - name: blocking
-      dtype: int64
-    - name: total_blocking
-      dtype: int64
-  - name: pinned_comment
-    dtype: 'null'
-  - name: is_pull_request
-    dtype: bool
-  splits:
-  - name: train
-    num_bytes: 36148813
-    num_examples: 5000
-  download_size: 29115375
-  dataset_size: 36148813
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+license: other
+task_categories:
+- text-classification
+- sentence-similarity
+- feature-extraction
+language:
+- en
+tags:
+- github
+- issues
+- semantic-search
+- text-data
+- nlp
+size_categories:
+- 1K<n<10K
+pretty_name: GitHub Issues Dataset
 ---
+
+# Dataset Card for GitHub Issues Dataset
+
+## Dataset Description
+This dataset contains raw GitHub issue records prepared for natural language processing tasks.
+
+The dataset was created from GitHub issue data and includes text fields such as title, body, and comments. No major cleaning or filtering has been applied. In particular:
+
+- Pull requests are NOT removed
+- Missing or incomplete records are NOT removed
+- The dataset reflects real-world, unclean data
+
+A column named `is_pull_request` is included to indicate whether each record corresponds to a pull request or a standard issue.
+
+The purpose of keeping the dataset in raw form is to allow preprocessing, cleaning, and feature engineering to be demonstrated as part of the analysis pipeline.
+
+## License
+
+This dataset is derived from publicly available GitHub issue data.
+
+The original content belongs to the respective repository owners and contributors.  
+This dataset is shared for educational and research purposes only.
+
+Users must comply with GitHub Terms of Service and the licenses of the original repositories.
+
+## Dataset Structure
+
+Each record represents one GitHub issue or pull request, including metadata, user information, and discussion content.
+
+### Data Fields
+
+The dataset includes the following key fields:
+
+#### Core Issue Information
+- `id`: Unique identifier of the issue
+- `number`: Issue number in the repository
+- `title`: Title of the issue
+- `body`: Main description text (may be empty)
+- `state`: Status of the issue (open/closed)
+- `locked`: Indicates if the issue is locked
+- `comments`: List of comments associated with the issue
+
+#### URLs and References
+- `url`, `html_url`: API and web links to the issue
+- `repository_url`: Link to the repository
+- `comments_url`, `events_url`, `labels_url`: Related API endpoints
+
+#### User Information
+- `user`: Information about the issue creator (e.g., login, id)
+- `assignee`: Assigned user (if available)
+- `assignees`: List of assigned users
+- `closed_by`: User who closed the issue
+
+#### Labels and Tags
+- `labels`: List of labels associated with the issue (name, color, description)
+
+#### Time Information
+- `created_at`: Issue creation timestamp
+- `updated_at`: Last update timestamp
+- `closed_at`: Issue closing timestamp
+
+#### Pull Request Information
+- `pull_request`: Contains pull request metadata if the record is a pull request
+- `is_pull_request`: Boolean flag indicating whether the record is a pull request
+
+#### Additional Metadata
+- `milestone`: Milestone information (if available)
+- `author_association`: Relationship of the author to the repository
+- `reactions`: Reaction counts (likes, etc.)
+- `timeline_url`: Timeline of issue events
+- `state_reason`: Reason for closing (if available)
+
+## Data Preprocessing
+
+This dataset is intentionally kept in raw format.
+
+No major preprocessing steps such as removing missing values or filtering pull requests were applied.
+
+However, a helper column (`is_pull_request`) was added to allow users to filter the dataset depending on their task.
+
+Users of this dataset are expected to perform their own preprocessing steps, such as:
+
+- Removing or handling missing values
+- Filtering pull requests if needed
+- Cleaning text data
+- Combining fields (e.g., title + body + comments)
+
+## Intended Uses
+
+This dataset is intended for educational and research purposes, particularly for:
+
+- Natural Language Processing (NLP)
+- Semantic search using embeddings (e.g., FAISS)
+- Text similarity and clustering
+- Feature extraction and data preprocessing exercises
+
+The dataset is especially suitable for demonstrating data cleaning, feature engineering, and handling of raw, unstructured data.
+
+## Out-of-Scope Uses
+
+This dataset should NOT be used for:
+
+- Identifying or profiling individual GitHub users
+- Making legal, financial, or employment decisions
+- Training high-risk AI systems without proper data cleaning and validation
+- Any use involving sensitive personal data without preprocessing and anonymisation
+
+## Limitations
+
+- The dataset contains missing and incomplete text fields.
+- Pull requests and issues are mixed together.
+- Text data may include noise, informal language, or irrelevant content.
+- Some records may not be useful without preprocessing.
+- Public GitHub data may still contain unintended sensitive or personal information.
+
+Because the dataset is raw, preprocessing is required before using it for machine learning tasks.
+
+## Ethical Considerations
+
+Since this dataset is collected from public GitHub sources and kept in raw form:
+
+- It may contain usernames or references to individuals
+- It may include unintended sensitive information in issue text
+- No automatic anonymisation has been applied
+
+Users must review and clean the dataset before using it in any sensitive or production context.
+
+Personal or sensitive information should be removed or masked where not necessary, in line with organisational AI and data governance policies. 
+
+## Data Classification
+
+This dataset is classified as **Internal/Public (educational use)**.
+
+Although the original data is publicly available, the processed dataset should still be handled responsibly. Data classification and handling should follow organisational rules for confidentiality, integrity, and access control