Development checklist
The idea behind the following checklist is to ensures that all development tasks are properly documented, reviewed, and tested, maintaining a high standard of quality and clarity throughout the project
Guidelines for Development
- Version Control:
- Ensure that all changes are pushed to the appropriate branch following the branching strategy.
- Commit changes regularly and use descriptive commit messages.
- if it’s a UI change, or a new script, then update release page with the new ui branch to deploy or the script to execute for each env
- API Integration Documentation in Confluence:
- Provide a detailed description of any web service integration or Kafka events (see Mandatory Documentation section).
- Include examples of request payloads and response payloads (see Mandatory Documentation section).
- Document any callback responses, if applicable (see Mandatory Documentation section).
- Provide an example of events sent or received, specifying their structure and content (see Mandatory Documentation section).
Code Review
- Submit Code for Review:
- Ensure that all implemented features and fixes are submitted for code review through the project’s code review tool.
- Review Checklist:
- Check for code efficiency, performance, and readability.
- Ensure that the code is secure and free of vulnerabilities.
- Confirm that appropriate test coverage is included (unit tests, integration tests, etc.), and not waiting for testers bugs 🙂
- Validate that all required documentation has been created or updated in Confluence.
- Feedback Implementation:
- Address all feedback received during the code review.
- Make necessary changes and update the code accordingly.
- Resubmit the code for further review if required.
Testing and Validation
- Unit Testing:
- Create unit tests for all new functions or classes implemented.
- Ensure that all unit tests pass before marking the task as complete.
- Integration Testing:
- Develop integration tests for any new integrations (APIs, services, Kafka events).
- Confirm that the integration works as expected in the testing environments.
- End-to-End Testing:
- Execute end-to-end tests to validate the complete workflow and user interactions.
- Ensure that all tests pass without errors or issues.
Mandatory Documentation in Confluence
- API/Web Service Integration:
- Include a detailed example of a request (JSON or XML format) and the corresponding response.
- Provide an example of the callback response, if applicable.
- Document the structure and content of any Kafka events sent or received, including headers and payload.
- Diagrams:
- Sequence Diagram: Create at least one sequence diagram to illustrate the interaction flow between different components or services for each user story.
- Architectural Diagram: Develop an architectural diagram to show the system’s structure, highlighting how the new features or integrations fit into the existing architecture.