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 move 2024 Conventions as comments to the new package example #20344

Merged
merged 3 commits into from
Dec 6, 2024

Conversation

yanganto
Copy link
Contributor

@yanganto yanganto commented Nov 20, 2024

Description

  • Fix typo in 2024 Conventions
  • Add Conventions as comments to a new package when sui move new
  • Add Conventions link to a new package when sui move new

Test plan

  • no extra tests needed

Release notes

  • CLI: Add Conventions as comments to a new package when sui move new

Copy link

vercel bot commented Nov 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 1:15am
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Dec 3, 2024 1:15am
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Dec 3, 2024 1:15am
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Dec 3, 2024 1:15am

@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Nov 20, 2024
@siomari siomari requested a review from damirka November 20, 2024 09:06
@damirka
Copy link
Contributor

damirka commented Nov 20, 2024

Thank you for your PR @yanganto! It is a fresh and interesting improvement, but I'm afraid filling every new project wit coding conventions may come out as noisy, and instead I suggest changing it to a single line with a link to coding conventions. Let me know if you're comfortable doing that, or we can pick it up some other time.

@yanganto
Copy link
Contributor Author

yanganto commented Nov 21, 2024

For developer experience, they just want to deliver a product with high quality, and do not want anyone to say their code is bad after product shipped.

Previous commit is exactly a new developer will want in my imagine.
"Just tell them what is the best practice clearly without asking a lot of document reading and still ambiguous".

For me, I will not insist on this PR or anything. My current topic is to bring the best practice to developer/new comer, I just try to make this smooth an easier. If there is no real best practice at this moment, it is still fine for me.

@yanganto yanganto temporarily deployed to sui-typescript-aws-kms-test-env November 21, 2024 05:13 — with GitHub Actions Inactive
crates/sui-move/src/new.rs Outdated Show resolved Hide resolved
crates/sui-move/src/new.rs Outdated Show resolved Hide resolved
@yanganto yanganto temporarily deployed to sui-typescript-aws-kms-test-env December 6, 2024 22:51 — with GitHub Actions Inactive
@ronny-mysten ronny-mysten enabled auto-merge (squash) December 6, 2024 22:52
@ronny-mysten ronny-mysten merged commit 24850f3 into MystenLabs:main Dec 6, 2024
47 of 48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants