docs: add local development and CI guide to template docs (#2) #241
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.
This PR addresses the "Fundamental Documentation" task in Issue #2.
While the template previously had documentation for the "server-side" (GitHub Actions and PyPI), it lacked guidance for the Developer Experience.
What's New:
Added a Local Development Workflow section to {{ cookiecutter.package_name }}/docs/ci.rst.
Documented pre-commit hooks, specifically explaining how to handle Mixed Line Endings (LF) and trailing whitespace.
Added instructions for using Tox to run style checks (tox -e codestyle) and tests locally.
Fixed YAML indentation and formatting in the existing CI examples to ensure a clean build.
This ensures that every new package created with this template will have clear instructions for its contributors from day one.