From 6bc238605210ddc3f354d6bb5d220af09a0ae1d7 Mon Sep 17 00:00:00 2001 From: chikamsoachumsft Date: Wed, 29 Oct 2025 17:14:18 -0400 Subject: [PATCH] Update contribution guidelines with code review process Added code review instructions to the contribution guidelines. --- .github/copilot-instructions.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index af1a647..29833f2 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,6 +1,6 @@ # Tailspin Toys Crowd Funding Development Guidelines -This is a crowdfunding platform for games with a developer theme. The application uses a Flask backend API with SQLAlchemy ORM for database interactions, and an Astro/Svelte frontend with Tailwind CSS for styling. Please follow these guidelines when contributing: +This is a crowdfunding platform for games with a developer theme. The application uses a Flask backend API with SQLAlchemy ORM for database interactions, and an Astro/Svelte frontend with Tailwind CSS[...] ## Code standards @@ -13,6 +13,18 @@ This is a crowdfunding platform for games with a developer theme. The applicatio - When adding new functionality, make sure you update the README - Make sure all guidance in the Copilot Instructions file is updated with any relevant changes, including to project structure and scripts, and programming guidance +### Code Review Instructions + +- All new pull requests must be reviewed by at least one other contributor before merging. +- Reviewers should check for adherence to code formatting requirements and project patterns described in this file. +- Confirm that all tests pass and the relevant scripts have been used (see "Required Before Each Commit" and "Scripts" sections). +- Ensure new functionality includes documentation updates, if applicable. +- Review API changes for RESTful design and use of Flask blueprints. +- Validate frontend changes for proper use of Svelte/Astro patterns and Tailwind CSS styling guidelines. +- Check for security best practices, especially in workflows and dependencies. +- Add comments to code and workflows where necessary for clarity. +- Provide constructive feedback to improve code quality and maintainability. + ### Code formatting requirements - When writing Python, you must use type hints for return values and function parameters.