Skip to content

Revised README for clarity and additional references by author#6

Merged
opensource-SantanderAI merged 2 commits into
SantanderAI:mainfrom
cc-jalvarez:main
Jun 29, 2026
Merged

Revised README for clarity and additional references by author#6
opensource-SantanderAI merged 2 commits into
SantanderAI:mainfrom
cc-jalvarez:main

Conversation

@cc-jalvarez

Copy link
Copy Markdown
Contributor

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 feature
  • fix — bug fix
  • [ X] docs — documentation only
  • test — adding or updating tests
  • refactor — code refactoring (no feature/fix)
  • ci — CI/CD changes
  • chore — maintenance

Linked issues

Checklist

  • Commit messages follow Conventional Commits
  • Tests added or updated (pytest tests/ -v --cov=situation_testing)
  • Coverage stays at or above 80%
  • Lint/format/type pass locally (ruff check . && black --check . && mypy src/)
  • Documentation updated (README, CHANGELOG, docstrings) if behaviour changed
  • No third-party data (e.g. the Law School dataset) is committed
  • I have signed the CLA (the bot will prompt me if not)
  • I agree to follow the project's Code of Conduct

Notes for reviewers

I am the author of this repo.

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.
@cc-jalvarez
cc-jalvarez requested a review from a team as a code owner June 23, 2026 22:44
@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@cc-jalvarez

Copy link
Copy Markdown
Contributor Author

JT, porfa acepta el PR para el nuevo README; gracias, JM.

@cc-jalvarez

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@cc-jalvarez

Copy link
Copy Markdown
Contributor Author

recheck

github-actions Bot added a commit that referenced this pull request Jun 23, 2026
@opensource-SantanderAI
opensource-SantanderAI requested a review from a team as a code owner June 29, 2026 15:56

@opensource-SantanderAI opensource-SantanderAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@opensource-SantanderAI
opensource-SantanderAI merged commit 07c564b into SantanderAI:main Jun 29, 2026
11 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants