Skip to content

Enhance README with productivity features and templates #4

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
JoeProgrammer88 merged 1 commit into from
Apr 7, 2026
Merged

Enhance README with productivity features and templates #4

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
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
- 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
Loading