-
Notifications
You must be signed in to change notification settings - Fork 0
Enhance ENTRY.md with participant and bot guidelines #2
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.
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
Conversation
…and bot description guidelines
WalkthroughThe changes update the participant submission templates across several starter and solution directories. The participant information section now requests details for all team members, rather than just one individual. A note clarifies that names may be shown publicly in tournament media, and emphasizes the necessity of providing a valid contact email. A new "Bot Description" section has been introduced, prompting participants to describe their bot’s functionality and strategies, which will be used to determine the "most interesting" prize. Previous notes about name usage have been consolidated and moved to the participant information section. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (4)
compiled_starters/gleam/example.ENTRY.md (2)
10-13
: Consistent note formatting suggestion.Duplicate of the suggestion above—consider using a Markdown blockquote or a single concise sentence for the note to improve readability.
15-20
: Uniform polite tone reminder.Duplicate of the earlier suggestion—add “Please” before “Let me know…” for consistent courtesy throughout the document.
🧰 Tools
🪛 LanguageTool
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...(INSERT_PLEASE)
solutions/gleam/01-qc6/code/example.ENTRY.md (2)
10-13
: Apply consistent note styling.Duplicate of the prior note recommendation—wrap the note in a blockquote or streamline it into one cohesive sentence.
15-20
: Consistent tone across Bot Description.Duplicate of the earlier tone suggestion—consider “Please let me know…” for consistent politeness.
🧰 Tools
🪛 LanguageTool
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...(INSERT_PLEASE)
🧹 Nitpick comments (2)
starter_templates/all/code/example.ENTRY.md (2)
10-13
: Consider refining the participant note for readability.This multi-line note could be wrapped in a Markdown blockquote or tightened into a single, well-punctuated sentence to improve scan-ability. For example:
Note: Your name(s) may be used in the tournament video/stream, so choose something you’re happy sharing (it doesn’t have to be your real name). Make sure the email is one you check so we can contact you if you win!
15-20
: Maintain a consistent polite tone in the Bot Description.Since the section begins with “Please provide…”, consider mirroring that politeness in the next sentence—e.g., “Please let me know about any interesting strategies…”—to keep the tone uniform.
🧰 Tools
🪛 LanguageTool
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...(INSERT_PLEASE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
compiled_starters/gleam/example.ENTRY.md
(1 hunks)solutions/gleam/01-qc6/code/example.ENTRY.md
(1 hunks)starter_templates/all/code/example.ENTRY.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
solutions/gleam/01-qc6/code/example.ENTRY.md
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...
(INSERT_PLEASE)
compiled_starters/gleam/example.ENTRY.md
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...
(INSERT_PLEASE)
starter_templates/all/code/example.ENTRY.md
[style] ~18-~18: Consider using polite language here.
Context: ... interesting' prize will be determined! Let me know about any interesting strategies your b...
(INSERT_PLEASE)
🔇 Additional comments (3)
starter_templates/all/code/example.ENTRY.md (1)
5-6
: Participant information phrasing is clear and inclusive.The prompt “Please provide the following information for all team members.” succinctly captures the requirement and helps ensure no one is missed.
compiled_starters/gleam/example.ENTRY.md (1)
5-6
: Participant information prompt is well written.This aligns with the updated template and clearly asks for all team members’ details.
solutions/gleam/01-qc6/code/example.ENTRY.md (1)
5-6
: Participant information section is clear.As in other templates, this line effectively requests full team details.
Add detailed instructions for participant information and bot descriptions to improve clarity and engagement.
Summary by CodeRabbit