Instruction file imported from prahveent/hackathon (
.github/instructions/git-commit.instructions.md). Copyright stays with the author.
#Git Commit Instructions
Simple Git Workflow
1. Check Status
git status2. Review Changes (Optional)
git diff3. Add Changes
git add .4. Commit Changes
git commit -m "your commit message here"5. Push to Remote
git pushCommit Message Examples
Good Commit Messages
git commit -m "add user login functionality"git commit -m "fix login form validation"git commit -m "update API documentation"git commit -m "add new product endpoints"
Complete Example
# Check what files have changed:
git status
# Review the changes (optional):
git diff
# Make your changes, then:
git add .
git commit -m "add user authentication to API"
git pushFirst Time Setup (One Time Only)
Configure Git User
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"Add Remote Repository
git remote add origin https://github.com/username/repository-name.gitQuick Reference
| Command | What it does |
|---|---|
git status |
Check what files have changed |
git diff |
Show detailed changes in files |
git add . |
Add all changes to staging |
git commit -m "message" |
Commit with message |
git push |
Push to remote repository |
git pull |
Get latest changes from remote |