From 913d0606c6a87b4db1aca8859c59b75a49b391f8 Mon Sep 17 00:00:00 2001 From: Son Nguyen Date: Sun, 27 Jul 2025 17:34:25 -0400 Subject: [PATCH] feat(api-ai): enhance AI agentic architecture and project basics done --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 2282a8f..f012f57 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ The reference task baked into this repo is a **Research & Outreach Agent** (“* * [Memory & Feedback](#memory--feedback) * [Extending the System](#extending-the-system) * [Testing & Quality](#testing--quality) +* [GitHub Actions](#github-actions) * [Security & Ops](#security--ops) * [Troubleshooting](#troubleshooting) * [Roadmap Ideas](#roadmap-ideas) @@ -509,6 +510,23 @@ make format make lint ``` +## GitHub Actions + +This repository uses GitHub Actions for continuous integration (CI) to ensure code quality and functionality. The CI pipeline includes: + +* **Linting**: checks code style and formatting using `ruff`. +* **Testing**: runs unit tests and smoke tests to verify functionality. +* **Type checking**: ensures type safety using `mypy`. +* **Dependency management**: checks for outdated dependencies and security vulnerabilities. +* **Documentation generation**: builds the documentation from the code comments and README. +* **Code coverage**: reports code coverage to ensure sufficient test coverage. +* **Release management**: automatically creates releases based on tags. +* **Docker build**: builds a Docker image for the application. +* **Security checks**: runs security scans on the codebase. +* and many more! + +You can view the CI pipeline in the `.github/workflows/` directory. This should provide you with a solid foundation for maintaining code quality and ensuring that your changes do not break existing functionality, and feel free to extend the CI pipeline with additional checks or steps as needed. + ## Security & Ops We also incorporate **DevSecOps** best practices to ensure the system is secure and production-ready: