diff --git a/README.md b/README.md index c8ee6c9..e238c91 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,14 @@ Target User: Website owner (single business owner) - Order Management: Create and manage customer orders - Each order will have a list of items, quantities, and total price - Templates: Create and manage templates for sublimation designs - - Each template will have a name, description, photoshop template file and image \ No newline at end of file + - Each template will have a name, description, photoshop template file and image + +## Project Productivity +This project uses some features and processes to improve productivity. This will be updated as the project continues. +- GitHub Action: Added as a CI pipeline to compile and run tests +- Branch Protection: Requires Pull Requests to merge code into main and requires the GitHub Action to pass. Optionally we can add required code review +- Repo Settings: + - Choose Squash Merge as only pull request merge option to keep history of main branch clean and easy to follow. + - Automatically delete head branches: New branches are created for each PR so old ones are automatically deleted on PR merge + - Issue Templates: Templates are used to help ensure higher quality issues. These will need to be refined as project continues + - AI Code Review and Assign Issue to Copilot: Used as applicable