Skip to content

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

Merged
merged 1 commit into from
Apr 26, 2025
Merged

Conversation

ryan-gang
Copy link
Collaborator

@ryan-gang ryan-gang commented Apr 26, 2025

Add detailed instructions for participant information and bot descriptions to improve clarity and engagement.

Summary by CodeRabbit

  • Documentation
    • Expanded participant information section to request details for all team members.
    • Clarified that participant names may be shown publicly and emphasized the need for a valid contact email.
    • Added a new section prompting for a detailed bot description, which will be used to determine the "most interesting" prize.

@ryan-gang ryan-gang self-assigned this Apr 26, 2025
Copy link

linear bot commented Apr 26, 2025

Copy link

coderabbitai bot commented Apr 26, 2025

Walkthrough

The 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

Files Change Summary
compiled_starters/gleam/example.ENTRY.md,
solutions/gleam/01-qc6/code/example.ENTRY.md,
starter_templates/all/code/example.ENTRY.md
Expanded participant info to cover all team members; clarified public name usage and email requirements; added a new "Bot Description" section for strategy explanations; reorganized and reworded notes about name usage.

Poem

In the warren of code, our team names now shine,
With emails for contact, and strategies defined.
Describe your bot’s cunning, its tricks and its flair—
For the "most interesting" prize, we’ll see who’ll compare!
🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 4bb6e41 and 94b4743.

📒 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.

@ryan-gang ryan-gang merged commit 36aa223 into main Apr 26, 2025
13 checks passed
@ryan-gang ryan-gang deleted the CC-1730 branch April 26, 2025 07:03
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