feat: add engineering standards skill

[MohammedSaudAlsahli]

No description provided.

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gemini-code-assist]

Summary of Changes

Hello @MohammedSaudAlsahli, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new SKILL.md document that formalizes the organization's engineering standards and protocols. It aims to establish a consistent and high-quality approach to software development across different technologies and domains, providing clear guidelines for design, implementation, and code review processes. The document covers a wide array of topics from core principles to specific language and framework best practices, ensuring a unified development methodology.

Highlights

• New Engineering Standards Document: A comprehensive Markdown document (SKILL.md) has been added, outlining the organization's professional engineering standards and protocols.
• Core Principles Defined: The document establishes universal core engineering principles, including Type Safety, Immutability, DRY, SOLID, and Security First practices.
• API Design Guidelines: Detailed standards for API design are introduced, covering RESTful maturity, HTTP status codes, response envelope structure, and patterns for pagination, filtering, and sorting.
• Frontend Ecosystem Standards: Specific guidelines are provided for TypeScript (strict mode, Zod validation), React (functional components, hooks, state management), Next.js (App Router, Server Components, Server Actions), and Angular (standalone components, signals, OnPush change detection).
• Backend & Systems Language Standards: Standards are defined for various backend languages, including Node.js/TypeScript, Python, Go, Rust, and Java, focusing on best practices for error handling, typing, concurrency, and modern features.
• Database, DevOps & QA Standards: Guidelines are included for SQL and NoSQL database practices, Git commit conventions, testing strategies (unit, integration), and documentation requirements.
• Refactoring Protocol: A structured protocol for code review and refactoring is introduced, emphasizing analysis, smell detection, standard application, and clear explanation of changes.

Changelog

• skills/engineering-standards/SKILL.md
  • Added a new document outlining comprehensive engineering standards and protocols for the organization.

Activity

• No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new skill file for engineering standards. The document is comprehensive and well-structured, covering a wide array of essential topics from core principles to language-specific best practices and DevOps. I have one suggestion to enhance the clarity of the Angular code example to prevent any potential confusion for developers.

[gemini-code-assist]

The Angular signal component pattern example is a bit confusing. The button text is 'Promote' and the handler is updateRole, but the implementation this.userId.set('456') changes the user ID, not the role. This can be misleading for developers trying to follow this pattern.

To make the example clearer and more consistent, the method name and button text should match the action.

Suggested change

	<button (click)="updateRole()">Promote</button>
	</div>
	`,
	changeDetection: ChangeDetectionStrategy.OnPush
	})
	export class UserProfileComponent {
	private authService = inject(AuthService);
	userId = signal<string>('123');
	userName = computed(() => `User: ${this.userId()}`);
	isAdmin = this.authService.isAdmin; // Signal from service
	updateRole() {
	this.userId.set('456');
	}
	<button (click)="changeUser()">Change User</button>
	</div>
	`,
	changeDetection: ChangeDetectionStrategy.OnPush
	})
	export class UserProfileComponent {
	private authService = inject(AuthService);
	userId = signal<string>('123');
	userName = computed(() => `User: ${this.userId()}`);
	isAdmin = this.authService.isAdmin; // Signal from service
	changeUser() {
	this.userId.set('456');
	}