Update README to match collection notebook

README.md

@@ -39,10 +39,12 @@ issues, and the scikit-learn project is well known, openly developed and well do
 
 ## 3. Data collection
 
+
+
 - Platform: GitHub (public issues of `scikit-learn/scikit-learn`)
-- Collection method: issues were retrieved from the GitHub REST API (`https://api.github.com/repos/scikit-learn/scikit-learn/issues`) using Python and the `requests` library, then assembled into a pandas DataFrame, saved as CSV and published to the Hugging Face Hub in Parquet format.
-- Collection date: 12 October 2026
-- Authentication: requests were authenticated with a GitHub personal access token. The token is not included in this dataset or repository.
+- Collection method: Issues were retrieved from the GitHub REST API (https://api.github.com/repos/scikit-learn/scikit-learn/issues) using Python's requests library. Results were paginated, pull requests were filtered out, and the selected fields were assembled into a pandas DataFrame and saved as CSV before being published to the Hugging Face Hub.
+- Collection date: 12/10/2026
+- Authentication: [CONFIRM: e.g. personal access token stored as an environment variable, not in the notebook or this repository]
 - Scope: the dataset contains issues only. No pull requests are included (no record has a `/pull/` URL).
 - Selection: the 300 records are the **oldest** issues in the repository (issue numbers 1 to 768, created between 2010-08-31 and 2012-04-13). They are not a random sample.
 
@@ -72,6 +74,7 @@ issues, and the scikit-learn project is well known, openly developed and well do
 - Duplicates: none found (all `issue_id`, `issue_number` and `html_url` values are unique).
 - Derived fields added: `text_length` and `time_to_close_hours`.
 - Missing values were **kept, not imputed**: 9 empty bodies, 235 records without labels, and 5 open issues without `closed_at` / `time_to_close_hours`.
+- [CONFIRM / EDIT: any other cleaning, e.g. whitespace stripping, label formatting]
 
 ## 6. Initial data summary
 
@@ -106,11 +109,11 @@ Not intended for: profiling individual contributors, or drawing conclusions abou
 
 ## 9. Ethics, legal and compliance
 
-- **Privacy:** issues are public, but they include public GitHub usernames and can contain links or occasional email-like text. Usernames have been kept as they appear publicly on GitHub. The dataset is not used to identify or profile individuals.
+- **Privacy:** issues are public, but they include public GitHub usernames and can contain links or occasional email-like text. [CONFIRM: usernames were kept / anonymised / removed.] The dataset is not used to identify or profile individuals.
 - **Attribution:** content originates from the scikit-learn GitHub project and its contributors; every record links back to its original issue via `html_url`.
 - **Licensing:** the scikit-learn software is BSD-3-Clause. This licence is for the software repository and is not assumed to cover user-written issue text, so this dataset is marked `license: other` and is shared for educational and research purposes only. Users should check GitHub's Terms of Service and the original project's terms before reuse.
-- **Terms of service:** data was collected from publicly available content through the official GitHub API.
-- **Organisational policy alignment:** the dataset was collected, stored and documented in line with the organisation's data storage, management and compliance policies provided for this assessment: public source data only, no private data, attribution to the original source, secure handling of credentials, and versioned storage.
+- **Terms of service:** data was collected from publicly available content within GitHub API access limits. [CONFIRM]
+- **Organisational policy alignment:** [INSERT: name the LMS policy documents on data storage, management and compliance you followed, and how.]
 - **Security:** API tokens are not stored in the notebooks or this repository.
 
 ## 10. Risks and corrective actions
@@ -127,9 +130,9 @@ Not intended for: profiling individual contributors, or drawing conclusions abou
 ## 11. Storage, versioning and reproducibility
 
 - Published on the Hugging Face Hub (git-based, so every commit is versioned): https://huggingface.co/datasets/BeNatural/github-scikit-learn-issues-dataset
-- Notebooks: three notebooks (data collection and augmentation, Transformers pipeline, FAISS semantic search) are submitted with this assessment as evidence.
-- Local copy: the CSV and notebooks are kept as a backup copy alongside the project files.
-- Version: v1.0, collected 12 October 2026. Any later changes to the data or processing should be recorded here.
+- Notebooks: [INSERT locations, e.g. `01_data_collection_augmentation.ipynb`, `02_transformers_pipeline.ipynb`, `03_faiss_semantic_search.ipynb`, and where they are stored]
+- Local copy: [INSERT location per organisational policy]
+- Version: v1.0 ([INSERT DATE]). Record any later changes to the data or processing here.
 
 ## 12. References