DM-40567: Add scriv to FastAPI and PyPI templates #220
Conversation
This file contains 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
jonathansick
approved these changes
Sep 8, 2023
project_templates/fastapi_safir_app/{{cookiecutter.name}}/CHANGELOG.md
Outdated
Show resolved
Hide resolved
project_templates/square_pypi_package/{{cookiecutter.name}}/CHANGELOG.md
Outdated
Show resolved
Hide resolved
rra
force-pushed
the
tickets/DM-40567
branch
from
9ec35e2 to
54d6518
Compare
|
Thanks, these are great comments. Here's a new version with those changes. |
We've been happy with scriv for change log management. Add it to the templates for both FastAPI Safir apps and SQuaRE PyPI packages, adding a CHANGELOG.md file to FastAPI Safir apps since we're standardizing on keeping change logs. Update the development documentation included in SQuaRE PyPI packages accordingly.
The previous version was unnecessarily verbose and included developer information about using scriv that is not likely to be of interest to the target audience. Omit the note about updating dependencies for PyPI apps; those changes aren't done automatically with PyPI apps and may be significant enough to note in the change log.
In the FastAPI Safir app and SQuaRE PyPI project templates, add scriv to the development dependencies.
rra
force-pushed
the
tickets/DM-40567
branch
from
54d6518 to
4ff472c
Compare
jonathansick
approved these changes
Sep 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We've been happy with scriv for change log management. Add it to the templates for both FastAPI Safir apps and SQuaRE PyPI packages, adding a CHANGELOG.md file to FastAPI Safir apps since we're standardizing on keeping change logs. Update the development documentation included in SQuaRE PyPI packages accordingly.