Skip to content

Update contribution guidelines with code review process #21

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.

Sign up for GitHub

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
chikamsoachumsft merged 1 commit into from
Oct 29, 2025
Merged

Update contribution guidelines with code review process #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand Down