Skip to content

Fix #371: Add Features, Reward Function, Termination, Contributing, a…#396

Open
ahmedmajid22 wants to merge 1 commit into
smallgig:mainfrom
ahmedmajid22:fix-371-readme-sections
Open

Fix #371: Add Features, Reward Function, Termination, Contributing, a…#396
ahmedmajid22 wants to merge 1 commit into
smallgig:mainfrom
ahmedmajid22:fix-371-readme-sections

Conversation

@ahmedmajid22
Copy link
Copy Markdown

Closes #371

Description

Adds missing README sections identified in the gap analysis by @jarl-hoyem.

Changes

  • Added Table of Contents with links to all sections
  • Added Features section — bullet list of key capabilities
  • Added Reward Function table — structured table replacing prose-only description
  • Added Termination heading — given its own ### header to match Truncation
  • Added Contributing section — links to CONTRIBUTING.md and good first issues
  • Added BoardGameGeek strategy link to Resources as suggested in the issue
  • Minor fixes: heading capitalisation consistency, removed stray comma in prose

Testing

  • Tests added/updated
  • Passes pre-commit hooks
  • Test coverage maintained (95%+)

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.

Add more sections to README.md

1 participant