Skip to content

Fix #371: Add Features, Reward Function, Termination, Contributing, and Contact sections to README - #402

Merged
RobMeetsAI merged 3 commits into
mainfrom
371-add-more-sections-to-readme
May 29, 2026
Merged

RobMeetsAI merged 3 commits into
mainfrom
371-add-more-sections-to-readme

Conversation

@ahmedmajid22

Copy link
Copy Markdown
Collaborator

Closes #371

What was added

  • Features — table of key capabilities, was completely missing
  • Reward Function — structured table replacing buried prose
  • Episode Termination — split cleanly into Terminated, Truncated, Failed Attempt subsections
  • Contributing — brief section with the 4-step workflow pointing to CONTRIBUTING.md
  • Contact — maintainer link
  • BoardGameGeek link — added to Resources as requested
  • Description — rewritten to reflect the actual game mechanics and strategic depth
  • Pull quote — attributed quote from Larry Levy's BGG review linking directly to it

What was not changed

  • All existing sections kept intact
  • No content removed
  • Badge block and GIF unchanged

@jarl-hoyem

Copy link
Copy Markdown
Collaborator

Thanks for the contribution - the new sections are a great addition and exactly what the project needed.

A small note: some of the changes - like the centered title header, navigation links, and reformatting of existing sections - were nice improvements, but they weren't part of the issue scope. In this project, structural and formatting changes like those go through Sprint Planning so we can decide together what changes and when.

If you'd like to propose them, open a new issue and we'll pick them up in the next sprint.

I've reverted those changes and kept all the new sections.

@RobMeetsAI RobMeetsAI left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Great.

@RobMeetsAI
RobMeetsAI merged commit 6da17b8 into main May 29, 2026
15 checks passed
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

3 participants