Skip to content

Revised README for clarity and additional references by author#6

Open
cc-jalvarez wants to merge 1 commit into
SantanderAI:mainfrom
cc-jalvarez:main
Open

Revised README for clarity and additional references by author#6
cc-jalvarez wants to merge 1 commit into
SantanderAI:mainfrom
cc-jalvarez:main

Conversation

@cc-jalvarez

Copy link
Copy Markdown

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
Author

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

@cc-jalvarez

Copy link
Copy Markdown
Author

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

@cc-jalvarez

Copy link
Copy Markdown
Author

recheck

github-actions Bot added a commit that referenced this pull request Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant