feat: add issue templates for Base44 backend and frontend updates
This commit introduces two new issue templates to streamline the process of updating the backend and frontend based on Base44 exports. The "API Validation and Backend Update from Base44" template is for analyzing API changes, updating the backend (Data Connect, Cloud Functions), and ensuring compatibility. It includes sections for objective, SR&ED justification, technical implementation notes, and acceptance criteria. The "Frontend Update from Base44" template is for integrating the latest UI changes (components, queries, mutations) from a Base44 export. It also includes sections for objective, SR&ED justification, technical implementation notes, and acceptance criteria.
This commit is contained in:
29
.github/ISSUE_TEMPLATE/base44_backend_validation.md
vendored
Normal file
29
.github/ISSUE_TEMPLATE/base44_backend_validation.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: 'API Validation and Backend Update from Base44'
|
||||
about: 'Use this template to analyze Base44 API changes and update our backend.'
|
||||
title: '[Base44] API Changes Validation and Backend Update'
|
||||
labels: 'enhancement, platform:backend, sred-eligible'
|
||||
---
|
||||
|
||||
### 🎯 Objective
|
||||
Analyze API and event changes from the latest Base44 export, validate their impact on our system, and update our backend (Data Connect, Cloud Functions) to ensure compatibility and integrate new functionalities.
|
||||
|
||||
---
|
||||
|
||||
### 🔬 SR&ED Justification
|
||||
* **Technological Uncertainty:** What is the impact of Base44 API schema changes (deprecated fields, new types, modified logic) on our Data Connect GraphQL schemas and Cloud Functions logic? Is there a risk of data corruption or contract breakage with client applications?
|
||||
* **Systematic Investigation:** We will perform a differential analysis ("diff") of the API schemas, update our GraphQL schema accordingly, adapt business logic in connectors and functions, and then deploy to a test environment to validate end-to-end integration.
|
||||
|
||||
---
|
||||
|
||||
### 💻 Technical Implementation Notes
|
||||
Refer to the [API Documentation Maintenance Guide](docs/06-maintenance-guide.md) for detailed steps on how to update the backend from a Base44 export.
|
||||
|
||||
---
|
||||
|
||||
### ✅ Acceptance Criteria
|
||||
- [ ] The impact analysis of API changes is documented.
|
||||
- [ ] Data Connect schemas and connectors are updated.
|
||||
- [ ] Affected Cloud Functions are updated.
|
||||
- [ ] Changes are deployed and validated in the `dev` environment.
|
||||
- [ ] **Given** an operation (query or mutation) affected by the changes is executed, **when** the API is called, **then** it should return a correct and consistent response with the new schema, without errors.
|
||||
29
.github/ISSUE_TEMPLATE/base44_frontend_update.md
vendored
Normal file
29
.github/ISSUE_TEMPLATE/base44_frontend_update.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: 'Frontend Update from Base44'
|
||||
about: 'Use this template to integrate the latest frontend changes from a Base44 export.'
|
||||
title: '[Base44] Frontend Update from Export'
|
||||
labels: 'enhancement, platform:web, sred-eligible'
|
||||
---
|
||||
|
||||
### 🎯 Objective
|
||||
Integrate the latest UI changes (components, queries, mutations) generated from the most recent Base44 export to keep our application up-to-date with the platform schema.
|
||||
|
||||
---
|
||||
|
||||
### 🔬 SR&ED Justification
|
||||
* **Technological Uncertainty:** How will the newly generated queries and mutations integrate with our existing state management and caching logic (e.g., TanStack Query) without introducing regressions or performance issues?
|
||||
* **Systematic Investigation:** We will implement the new generated hooks, refactor affected components, and perform performance and non-regression tests to validate that the integration is robust and performant.
|
||||
|
||||
---
|
||||
|
||||
### 💻 Technical Implementation Notes
|
||||
Refer to the [API Documentation Maintenance Guide](docs/06-maintenance-guide.md) for detailed steps on how to update the frontend from a Base44 export.
|
||||
|
||||
---
|
||||
|
||||
### ✅ Acceptance Criteria
|
||||
- [ ] The Data Connect generated code is updated to the latest version.
|
||||
- [ ] All components and pages affected by the changes are updated and function as expected.
|
||||
- [ ] The code is linted and formatted correctly.
|
||||
- [ ] The functionality is manually tested and works in the `dev` environment.
|
||||
- [ ] **Given** I navigate to a page affected by the update, **when** data is loaded, **then** I should see the new data structured correctly with no console errors.
|
||||
Reference in New Issue
Block a user