Skip to content

Add DevOps, CI/CD, and performance optimization instructions #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jul 8, 2025

Conversation

VamshiVerma
Copy link
Contributor

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Added a bunch of new instruction files covering DevOps and performance stuff that I've found really useful in my own projects. These are based on real experience and common pain points I've encountered.

The new files cover:

  • DevOps principles and culture (CALMS framework, DORA metrics)
  • GitHub Actions workflows and CI/CD best practices
  • Docker containerization tips and multi-stage builds
  • Kubernetes deployment strategies and troubleshooting

Each file has practical examples, checklists, and common gotchas I've learned the hard way. Tried to make them comprehensive but still easy to follow.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify):

Additional Notes

These instructions are pretty detailed - I wanted to make sure they'd actually be useful rather than just surface-level stuff. Each one has real examples and scenarios commonly dealt with.

Also, everything is properly linked in the README and follows the repo's formatting standards. Please, let me know if there are questions or concerns.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

@aaronpowell aaronpowell requested a review from Copilot July 7, 2025 06:19
Copilot

This comment was marked as outdated.

Copy link
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some comments from Copilot on styling to go

@VamshiVerma VamshiVerma requested a review from aaronpowell July 8, 2025 01:15
@aaronpowell aaronpowell requested a review from Copilot July 8, 2025 02:07
Copilot

This comment was marked as outdated.

@aaronpowell aaronpowell requested a review from Copilot July 8, 2025 02:11
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request introduces four comprehensive instruction files for DevOps and performance optimization, covering foundational DevOps principles, containerization best practices, CI/CD automation with GitHub Actions, and Kubernetes deployment strategies. These instructions provide detailed, real-world guidance for building robust, secure, and efficient software delivery pipelines.

  • Added DevOps core principles instruction file covering CALMS framework and DORA metrics
  • Added Docker containerization best practices with multi-stage builds and security guidance
  • Added comprehensive GitHub Actions CI/CD workflow instructions
  • Added Kubernetes deployment best practices covering orchestration and security

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
instructions/devops-core-principles.instructions.md Foundational DevOps principles covering CALMS framework and DORA metrics
instructions/containerization-docker-best-practices.instructions.md Comprehensive Docker best practices for secure, optimized container creation
instructions/github-actions-ci-cd-best-practices.instructions.md Detailed GitHub Actions workflow guidance for robust CI/CD pipelines
instructions/kubernetes-deployment-best-practices.instructions.md Complete Kubernetes deployment strategies and security practices
README.md Updated with entries for all four new instruction files

@@ -0,0 +1,167 @@
---
applyTo: ['*']
description: 'Foundational instructions covering core DevOps principles, culture (CALMS), and key metrics (DORA) to guide GitHub Copilot in understanding and promoting effective software delivery.'
Copy link
Preview

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description field in the front matter should be wrapped in single quotes instead of single quotes to maintain consistency with project standards.

Copilot uses AI. Check for mistakes.

@@ -0,0 +1,684 @@
---
applyTo: ['*']
description: 'Comprehensive best practices for creating optimized, secure, and efficient Docker images and managing containers. Covers multi-stage builds, image layer optimization, security scanning, and runtime best practices.'
Copy link
Preview

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description field in the front matter should be wrapped in single quotes instead of single quotes to maintain consistency with project standards.

Copilot uses AI. Check for mistakes.

@@ -0,0 +1,607 @@
---
applyTo: ['*']
description: 'Comprehensive guide for building robust, secure, and efficient CI/CD pipelines using GitHub Actions. Covers workflow structure, jobs, steps, environment variables, secret management, caching, matrix strategies, testing, and deployment strategies.'
Copy link
Preview

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description field in the front matter should be wrapped in single quotes instead of single quotes to maintain consistency with project standards.

Copilot uses AI. Check for mistakes.

@@ -0,0 +1,307 @@
---
applyTo: ['*']
description: 'Comprehensive best practices for deploying and managing applications on Kubernetes. Covers Pods, Deployments, Services, Ingress, ConfigMaps, Secrets, health checks, resource limits, scaling, and security contexts.'
Copy link
Preview

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description field in the front matter should be wrapped in single quotes instead of single quotes to maintain consistency with project standards.

Copilot uses AI. Check for mistakes.

@aaronpowell aaronpowell merged commit 25f4ba1 into github:main Jul 8, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants