Skip to content
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

Add citation #1

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Add citation #1

merged 1 commit into from
Jul 11, 2024

Conversation

zechengz
Copy link
Member

No description provided.

@zechengz zechengz self-assigned this Jul 10, 2024
Copy link

coderabbitai bot commented Jul 10, 2024

Walkthrough

The update to the README.md file introduces a new citation section, encouraging users to reference a specific paper if they use the related work. This addition aims to give proper credit and maintain academic integrity.

Changes

File Change Summary
README.md Added a citation section for referencing a paper

Poem

In the README, a change so bright,
A citation to bring scholars delight. 📚
For those who build on work profound,
Proper credit shall now resound.
A rabbit’s touch, simple and neat,
Ensuring credit, truly sweet! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Outside diff range and nitpick comments (5)
README.md (5)

53-53: Consider adding a comma.

For better readability, consider adding a comma after "Firefox".

- python examples/desktop_env.py "Open Firefox"
+ python examples/desktop_env.py "Open Firefox",
Tools
LanguageTool

[typographical] ~53-~53: Consider adding a comma here.
Context: ...op_env.py "Open Firefox"


## Cite
Please cite [our paper](https://arxiv.org/abs/...

(PLEASE_COMMA)

</blockquote></details>

</details>

---

`55-55`: **Specify the language for the fenced code block.**

To adhere to Markdown best practices, specify the language for the fenced code block.

```diff
- ```
+ ```bibtex
Tools
Markdownlint

55-55: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


57-58: Correct the title capitalization.

Capitalize "environment" in the title for consistency.

- title={CRAB: Cross-environment Agent Benchmark for Multimodal Language Model Agents},
+ title={CRAB: Cross-Environment Agent Benchmark for Multimodal Language Model Agents},

58-58: Correct the author list format.

Ensure the list of authors ends with "and others" consistently.

- author={Xu, Tianqi and Chen, Linyao and Wu, Dai-Jie and Chen, Yanjun and Zhang, Zecheng and Yao, Xiang and Xie, Zhiqiang and Chen, Yongchao and Liu, Shilong and Qian, Bochen and others},
+ author={Xu, Tianqi and Chen, Linyao and Wu, Dai-Jie and Chen, Yanjun and Zhang, Zecheng and Yao, Xiang and Xie, Zhiqiang and Chen, Yongchao and Liu, Shilong and Qian, Bochen and others},

60-60: Correct the page range format.

Ensure the page range is formatted correctly.

- pages={arXiv--2407},
+ pages={arXiv:2407},
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aa8a713 and af6e78f.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
LanguageTool
README.md

[typographical] ~53-~53: Consider adding a comma here.
Context: ...op_env.py "Open Firefox"


## Cite
Please cite [our paper](https://arxiv.org/abs/...

(PLEASE_COMMA)

</blockquote></details>

</blockquote></details>
<details>
<summary>Markdownlint</summary><blockquote>

<details>
<summary>README.md</summary><blockquote>

55-55: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</blockquote></details>

</blockquote></details>

</details>


</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@dandansamax dandansamax merged commit eba9cfb into main Jul 11, 2024
1 check passed
@dandansamax dandansamax deleted the zecheng_add_citation branch July 14, 2024 15:27
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.

2 participants