Skip to content

updating the docs to make it easier to change #789

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

Open
Abhayamani wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updating the docs to make it easier to change #789

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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
Welcome to Code Racer, a community project built with <a href="https://nextjs.org/">Next.js</a>, <a href="https://tailwindcss.com">Tailwind CSS</a>, and <a href="https://www.typescriptlang.org">TypeScript</a>.
Code Racer is a multiplayer coding game where developers can compete against each other to solve programming challenges in real-time. Sharpen your coding skills, challenge your peers, and have fun while racing against the clock!
</div>
<div>Just updating the branch right now
</div>
Comment on lines +11 to +12
Copy link

@coderabbitai coderabbitai bot Mar 21, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove temporary branch-status text from README

Line 11 adds a transient message (“Just updating the branch right now”) that looks like internal WIP/debug context rather than project documentation. Please remove it (or replace it with durable contributor-facing info).

Suggested change 
-<div>Just updating the branch right now
-</div>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<div>Just updating the branch right now
</div>
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 11 - 12, Remove the transient WIP line that reads
"Just updating the branch right now" from the README (it appears as an internal
branch-status/debug message). Edit the README.md to delete that div/text or
replace it with permanent, contributor-facing documentation (e.g., a short
contribution guideline or nothing), ensuring no leftover WIP/debug strings
remain.


<div align="center">
<!-- TO ADD more Badges use -> https://shields.io/ -->
Expand Down