8000 add Agents.md by bobzhang · Pull Request #2304 · moonbitlang/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add Agents.md #2304

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

Jump to bottom
Merged
merged 2 commits into from
Jun 20, 2025
Merged

add Agents.md #2304

merged 2 commits into from
Jun 20, 2025

Conversation

bobzhang
Copy link
Contributor

No description provided.

@peter-jerry-ye-code-review peter-jerry-ye code review
Copy link
peter-jerry-ye-code-review bot commented Jun 20, 2025 •
edited
Loading
Typo in documentation about testing command

Category
Correctness
Code Snippet

  • Youd should run moon test
    Recommendation
    Change 'Youd' to 'You'
    Reasoning
    Simple typo that affects readability and professionalism of documentation
Incomplete sentence in `moon info` description

Category
Correctness
Code Snippet
has a generated interface file .mbti file, it is a breif formal description of the package, it is
nothing changes
Recommendation
Revise to: 'has a generated interface file (.mbti), which is a brief formal description of the package. If this file shows no changes, it means your modifications don't affect the package's external interface.'
Reasoning
The current text has grammatical errors and an incomplete thought, making it difficult for readers to understand the purpose of the moon info command

Missing examples in documentation

Category
Maintainability
Code Snippet

  • MoonBit code is organized in block style, each block is separated by ///|
    Recommendation
    Add a code example showing block organization:
fn example1() { }
///|
fn example2() { }

Reasoning
Adding concrete examples helps developers better understand the block organization concept, especially for newcomers to the language

@coveralls
Copy link
Collaborator
coveralls commented Jun 20, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 7399

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.886%
Totals Coverage Status
Change from base Build 7394: 0.0%
Covered Lines: 8505
Relevant Lines: 9462
💛 - Coveralls

@bobzhang bobzhang requested a review from Copilot June 20, 2025 07:17
@bobzhang bobzhang merged commit 909d1c9 into main Jun 20, 2025
16 checks passed
@bobzhang bobzhang deleted the hongbo/add_agents.md branch June 20, 2025 07:17
Copilot
Copilot AI reviewed Jun 20, 2025
View reviewed changes
Copy link
Contributor
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new documentation file (AGENTS.md) providing refactoring tips for MoonBit.

  • Introduces guidelines for organizing MoonBit code blocks and file structure.
  • Outlines various command line operations (e.g., formatting, testing, linting) for maintaining MoonBit projects.

AGENTS.md
- You should run `moon fmt` to check your code is formatted correctly.

- You should run `moon info` to update the generated interface of interface file, each package
has a generated interface file `.mbti` file, it is a breif formal description of the package, it is
Copy link
Preview
Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

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

Correct 'breif' to 'brief' and consider removing the redundant 'file' word for clarity.

Suggested change
has a generated interface file `.mbti` file, it is a breif formal description of the package, it is
has a generated interface file `.mbti`, it is a brief formal description of the package, it is

Copilot uses AI. Check for mistakes.

AGENTS.md
has a generated interface file `.mbti` file, it is a breif formal description of the package, it is
nothing changes, this means your change does not bring the visible changes to the external package users.

- Youd should run `moon test` to check the test is passed. MoonBit supports snapshot testing, so in some cases,
Copy link
Preview
Copilot AI Jun 20, 2025

Choose a reason for hiding this comment

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

Correct 'Youd' to 'You should' for proper spelling and clarity.

Suggested change
- Youd should run `moon test` to check the test is passed. MoonBit supports snapshot testing, so in some cases,
- You should run `moon test` to check the test is passed. MoonBit supports snapshot testing, so in some cases,

Copilot uses AI. Check for mistakes.

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

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bobzhang @coveralls
0