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

Merged
merged 2 commits into from
Jun 20, 2025
Merged

add Agents.md #2304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa63fd8
add Agents.md
bobzhang Jun 20, 2025
5f3e475
Update AGENTS.md to include guidelines for managing deprecated blocks…
bobzhang Jun 20, 2025
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
27 changes: 27 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
This is the standard library for [MoonBit](docs.moonbitlang.com).

# Refactoring tips

- MoonBit code is organized in block style, each block is separated by `///|`,
the order of each block is irrelevant. In some refactorings, you can process
block by block independently.

- Try to keep deprecated blocks in file called `deprecated.mbt` in each directory.

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

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.

your changes indeed change the behavior of the code, you should run `moon test --update` to update the snapshot.

- You can run `moon check` to check the code is linted correctly.

- MoonBit packages are organized per directory, for each directory, there is a `package.json` file listing its dependencies.
Each package has its files and blackbox test files (common, ending in `_test.mbt`) and whitebox test files (ending in `_wbtest.mbt`).

- In the toplevel directory, this is a `moon.mod.json` file listing about the module and some meta information.


0