🔄 Change Control & Versioning Policy¶
This document defines the change control, versioning, and changelog policy for technical guidelines and repositories within LOGYCA.
Its purpose is to ensure clarity, traceability, auditability, and controlled evolution of technical standards and documentation.
📌 Governance Rule
Any change not documented according to this policy is considered non-compliant.
🎯 Objectives¶
- Ensure traceability of all changes
- Prevent uncontrolled modifications
- Provide a clear version history
- Support audits and reviews
- Enable safe adoption of technical guidelines
✏️ Change Control¶
Who Can Edit¶
-
Minor changes (typos, clarifications, formatting)
→ Any team member -
Structural or semantic changes (rules, architecture, scope)
→ Must be done via Pull Request
Change Best Practices¶
- Changes must be clear and intentional
- Do not remove historical information
- Always document the reason for the change
- Prefer incremental changes over large unreviewed updates
Auditability¶
- All changes are tracked via the version control system
- Git history is considered the source of audit truth
- Pull Requests must include context and justification
🧾 Technical Guidelines Versioning¶
This document and all technical guidelines are versioned to guarantee:
- Proper usage
- Clear communication
- Controlled evolution of standards
📌 Document Status¶
Each document must clearly indicate its current status:
| Status | Description |
|---|---|
| Draft | Work in progress, not mandatory |
| Active | Official and mandatory guideline |
| Deprecated | Must not be used for new developments |
👤 Ownership & Responsibility¶
- Versioning is owned by the Architecture Team
- All changes must be documented
- Major changes require:
- Formal review
- Explicit approval
- Official communication
✅ Mandatory Usage¶
Only documents with status Active must be used as a reference for new developments.
Deprecated or Draft versions are for reference only.
📜 Changelog Usage¶
This repository follows the Keep a Changelog standard and adheres to Semantic Versioning.
Example for CHANGELOG.md
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Types of changes
- Added for new features.
- Changed for changes in existing functionality.
- Deprecated for soon-to-be removed features.
- Removed for now removed features.
- Fixed for any bug fixes.
- Security in case of vulnerabilities.
## Semantic Versioning
< MAJOR >.< MINOR >.< PATCH >
* **MAJOR**: version when you make incompatible API changes
* **MINOR**: version when you add functionality in a backwards compatible manner
* **PATCH**: version when you make backwards compatible bug fixes
### Definitions for releasing versions
* https://peps.python.org/pep-0440/
- X.YaN (Alpha release): Identify and fix early-stage bugs. Not suitable for production use.
- X.YbN (Beta release): Stabilize and refine features. Address reported bugs. Prepare for official release.
- X.YrcN (Release candidate): Final version before official release. Assumes all major features are complete and stable. Recommended for testing in non-critical environments.
- X.Y (Final release/Stable/Production): Completed, stable version ready for use in production. Full release for public use.
---
## [1.0.1] - 2025-12-17
### Fixed
- Minor bug fix in data transformation pipeline when handling empty datasets.
- Improved error handling for invalid input formats.
---
## [1.0.0] - 2025-12-16
### Added
- Added validation functions: str, email.
- A 🖐️ Manual Trigger Simulator is created to test the code without needing to be called from a webhook trigger.
- Ready for production launch.
---
## [0.3.0] - 2025-12-12
### Added
- Added validation functions: str, email.
---
## [0.2.0] - 2025-12-12
### Changed
- Corrected validation functions: bool, int, float.
---
## [0.1.0] - 2025-12-09
### Added
- Creation of the Python simulator for local development using n8n inputs.
- Validation functions are created.
---
## [0.0.2] - 2025-12-05
### Changed
- Review of sticky notes.
---
## [0.0.1] - 2025-12-03
### Added
- Initial repository setup.
- Project structure creation.