docs: Update CONTRIBUTING.md with database migration guidelines #68
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.
Expanded the documentation to include instructions for adding and managing database migrations in the project. Clarified the structure of the database schema, added details about UTC timestamp storage, and updated the description of the internal storage module to mention migrations.
Pull Request Checklist
mainbranch of tmpo.Description
This pull request updates the documentation in
CONTRIBUTING.mdto clarify the structure and management of the database, with a particular focus on migrations and schema details. The changes provide clearer guidance for contributors on how to handle database schema modifications and describe the current schema in more detail.Database schema and storage documentation:
internal/storage/directory to include migrations, not just database operations and models.time_entries,milestones, andsettingstables, including their purposes and a note about UTC timestamp storage and timezone conversion.Guidance for database migrations:
internal/storage/migrations.go, including code examples and important safety notes about transactional execution.