8000 Fix typos and add EOF newlines by bobzhang · Pull Request #2245 · moonbitlang/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix typos and add EOF newlines #2245

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 1 commit into from
Jun 11, 2025
Merged

Fix typos and add EOF newlines #2245

merged 1 commit into from
Jun 11, 2025

Conversation

bobzhang
Copy link
Contributor

Summary

Testing

  • git diff --check
  • moon check --deny-warn

https://chatgpt.com/codex/tasks/task_e_6849455c5f4883208388e95d20cd932d

@peter-jerry-ye-code-review peter-jerry-ye code review
Copy link
Inconsistent formatting in configuration files

Category
Maintainability
Code Snippet
All moon.*.json files previously missing newlines at EOF
Recommendation
Add trailing newlines to all configuration files and enforce this with an EditorConfig file
Reasoning
Trailing newlines in text files are a POSIX standard and help prevent issues with concatenation and display. Adding an EditorConfig file would help automatically enforce this convention across the project.

Inconsistent capitalization in type naming convention documentation

Category
Maintainability
Code Snippet
CONTRIBUTING.md: - type names, CamlCase is preferred
Recommendation
Consider adding examples of correct and incorrect type naming to make the convention clearer, e.g.:

// Good
type UserProfile = ...
// Bad
type user_profile = ...

Reasoning
Clear examples help prevent confusion and improve code consistency across the project. The typo correction from CamlCase to CamelCase is good, but adding examples would make it even clearer.

Timeline information may become outdated

Category
Maintainability
Code Snippet
README.md: we are expected to reach beta-preview status in mid-August
Recommendation
Consider removing specific timeline predictions or moving them to a separate releases/roadmap document that can be updated more frequently
Reasoning
Having specific dates in the main README can lead to outdated information if not regularly updated. A separate roadmap document would be easier to maintain and would avoid giving potentially incorrect expectations to users.

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 7206

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 93.087%
Totals Coverage Status
Change from base Build 7204: 0.0%
Covered Lines: 8551
Relevant Lines: 9186
💛 - Coveralls

@bobzhang bobzhang merged commit 338b375 into main Jun 11, 2025
8 of 12 checks passed
@bobzhang bobzhang deleted the codex/find-easy-tasks-for-pr branch June 11, 2025 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
codex
Projects
None yet
Milestone
No milestone
Development

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