Extract setup and development docs to CONTRIBUTING.md#35
Merged
Conversation
Updated project name and removed outdated sections. Signed-off-by: Bradley Reynolds <bradley.reynolds@tailstory.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Moves setup instructions, demo/API running instructions, endpoint documentation, and development workflow from README.md to a new CONTRIBUTING.md file. This declutters the README and follows the common convention of keeping contribution guidelines in a separate document.
The README now contains only the project overview and directory structure, with a brief pointer to CONTRIBUTING.md for detailed setup and development information.
Related issues
None
Checklist
uv run nox -s lintspasses (prek + ruff format + ruff check +mypy --strict+ ty)uv run nox -s testspasses, and I added/updated tests for any behavior changedocs/updated if public API or behavior changeduv.lockupdated if dependencies changedengine/and HTTP stays inapi/(no cross-layer leaks)Note: This is a documentation-only change. No source code or tests were modified.
https://claude.ai/code/session_01FDGM3ZQzYmHoLViSr4TtF1