Skip to content

docs: add 'Adding a New Domain' section to CONTRIBUTING.md#5

Merged
sqllocks merged 1 commit into
mainfrom
docs/contributing-domain-section
May 15, 2026
Merged

docs: add 'Adding a New Domain' section to CONTRIBUTING.md#5
sqllocks merged 1 commit into
mainfrom
docs/contributing-domain-section

Conversation

@sqllocks
Copy link
Copy Markdown
Owner

Summary

Adds an explicit "Adding a New Domain" section to CONTRIBUTING.md, between Running Tests and Adding a Custom Strategy.

Motivation: Issue #1 invites contributors to add a small new domain, but CONTRIBUTING.md doesn't describe the scaffold flow. This PR closes that gap so first-time contributors who land on the repo via search or stars (not via the issue tracker) get the same guidance.

What changed

  • New section: "Adding a New Domain" (~25 lines)
  • Covers: scaffold copy, schema definition, calibration source citation, smoke test, docs entry, PR tagging
  • Lists suggested domain ideas (bookstore, events, library, conference, gym, telecom, gaming, logistics)
  • Links to Discussions + Issue Add a small new domain (e.g. bookstore or events) #1 for contributors who want to talk it through first

Test plan

  • Markdown renders correctly
  • All internal links resolve
  • No changes to code

🤖 Generated with Claude Code

@sqllocks sqllocks merged commit b07f72b into main May 15, 2026
0 of 6 checks passed
@sqllocks sqllocks deleted the docs/contributing-domain-section branch May 15, 2026 16:30
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