Revised README for clarity and additional references by author#6
Merged
Conversation
Updated README to enhance clarity and detail about the project, including references and citation requirements as requested by the author of the paper and repo.
|
All contributors have signed the CLA ✍️ ✅ |
Contributor
Author
|
JT, porfa acepta el PR para el nuevo README; gracias, JM. |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
Contributor
Author
|
recheck |
opensource-SantanderAI
approved these changes
Jun 29, 2026
opensource-SantanderAI
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Docs-only README revision by the paper's author (Jose M. Álvarez): adds the paper title/arXiv link, an abstract summary, a References section with BibTeX citations, and dataset citation note. All checks green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated README to enhance clarity and detail about the project, including references and citation requirements as requested by the author of the paper and repo.
Summary
The new README clarifies the origin of this repo, including the proper references to the author's papers and repo.
Type of change
feat— new featurefix— bug fixdocs— documentation onlytest— adding or updating testsrefactor— code refactoring (no feature/fix)ci— CI/CD changeschore— maintenanceLinked issues
Checklist
pytest tests/ -v --cov=situation_testing)ruff check . && black --check . && mypy src/)Notes for reviewers
I am the author of this repo.