Update README.md
Browse files
README.md
CHANGED
|
@@ -148,13 +148,25 @@ user_* fields Additional metadata about the user (avatar, profile URLs, etc.)
|
|
| 148 |
- performed_via_github_app is always null.
|
| 149 |
- Reactions may not reflect full emotional tone.
|
| 150 |
|
| 151 |
-
## Ethical Considerations
|
| 152 |
-
- All data is publicly available via GitHub’s API.
|
| 153 |
-
- Usernames and profile links are included; please respect contributor privacy and avoid misuse.
|
| 154 |
-
|
| 155 |
## Dataset Creation script
|
| 156 |
- Data was collected using Python requests library by GitHub REST API:
|
| 157 |
- url = "https://api.github.com/repos/huggingface/datasets/issues/comments?per_page=100&page={page}"
|
| 158 |
- headers = {"Authorization": f"token {your_token}"}
|
| 159 |
- response = requests.get(url, headers=headers)
|
| 160 |
- Comments were flattened into a tabular format with 39 columns. Timestamps were parsed, and nested fields (e.g., user, reactions) were expanded.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 148 |
- performed_via_github_app is always null.
|
| 149 |
- Reactions may not reflect full emotional tone.
|
| 150 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 151 |
## Dataset Creation script
|
| 152 |
- Data was collected using Python requests library by GitHub REST API:
|
| 153 |
- url = "https://api.github.com/repos/huggingface/datasets/issues/comments?per_page=100&page={page}"
|
| 154 |
- headers = {"Authorization": f"token {your_token}"}
|
| 155 |
- response = requests.get(url, headers=headers)
|
| 156 |
- Comments were flattened into a tabular format with 39 columns. Timestamps were parsed, and nested fields (e.g., user, reactions) were expanded.
|
| 157 |
+
|
| 158 |
+
## License
|
| 159 |
+
- This dataset is released under the Apache 2.0 License, which permits commercial and non-commercial use, distribution, modification and private use, provided that proper attribution is given and a copy of the license is included with any redistribution.
|
| 160 |
+
|
| 161 |
+
## Ethical Considerations
|
| 162 |
+
- All data is publicly available via GitHub’s API.
|
| 163 |
+
- Usernames and profile links are included; please respect contributor privacy and avoid misuse.
|
| 164 |
+
|
| 165 |
+
## Privacy considerations
|
| 166 |
+
- All data was collected from publicly accessible GitHub issue comments via the GitHub REST API.
|
| 167 |
+
- Usernames, profile URLs and other metadata are included as part of the original public content.
|
| 168 |
+
- No private or sensitive data was collected or included.
|
| 169 |
+
|
| 170 |
+
## Storage and Distribution:
|
| 171 |
+
- The dataset is stored and distributed via the Hugging Face Hub.
|
| 172 |
+
- Users downloading or hosting the dataset are responsible for ensuring compliance with GitHub’s Terms of Service and applicable data handling policies.
|