Skip to content

docs: add missing git add command to contribution workflow#18

Open
Mohit-001-hash wants to merge 1 commit into
NexGenStudioDev:masterfrom
Mohit-001-hash:fix-contribution-workflow
Open

docs: add missing git add command to contribution workflow#18
Mohit-001-hash wants to merge 1 commit into
NexGenStudioDev:masterfrom
Mohit-001-hash:fix-contribution-workflow

Conversation

@Mohit-001-hash

Copy link
Copy Markdown

Summary

This PR resolves a workflow friction point in the "Contribution" section. The provided bash snippet for contributing previously skipped the staging step (git add .) before committing. If a user copy-pasted the commands exactly, it resulted in a Git error. I added the missing git add . command to ensure the instructions are functional out-of-the-box for new open-source contributors. I also corrected a small scaffolding leftover in the project structure diagram (my-react-app -> commdesk).

Closes #None (just a documentation fix)


Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that changes existing behavior)
  • 📝 Documentation update
  • ♻️ Refactor / code cleanup (no functional change)
  • ⚡ Performance improvement
  • 🔒 Security fix
  • 🧪 Tests only

What Changed

  • Added git add . to the terminal commands in the Contribution section.
  • Renamed the root folder in the Project Structure diagram from my-react-app/ to commdesk/ to match the repository name.

How to Test

No tests required (Documentation only).


Screenshots / Recordings

None


Checklist

  • Linked the related issue above
  • Self-reviewed my own diff
  • No unnecessary console.log, debug code, or commented-out blocks
  • npm run lint passes locally
  • No TypeScript errors (npm run type-check)
  • Added or updated tests where applicable
  • Updated documentation / comments if behavior changed

Accessibility (UI changes only)

None


Additional Context

None

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the contribution guidelines in the README.md file to include the staging step (git add .) before committing changes. The reviewer pointed out a discrepancy where a project structure update mentioned in the pull request description was missing from the actual changes.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md

# Commit changes
# Stage and commit changes
git add .

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The pull request description mentions that the root folder in the project structure diagram was updated from my-react-app/ to commdesk/. However, this change is not included in the current diff (line 25 of README.md still reads my-react-app/). Please add this modification to the pull request to keep the documentation consistent with the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant