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.

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

Change import paths azle/canisters/[canisterName] to azle/canisters/[canisterName]/idl (breaking changes) #2668

Merged
merged 5 commits into from
Feb 11, 2025
Merged

Change import paths azle/canisters/[canisterName] to azle/canisters/[canisterName]/idl (breaking changes) #2668

merged 5 commits into from
Feb 11, 2025

Conversation

lastmjs
Copy link
Member

@lastmjs lastmjs commented Feb 8, 2025 •
edited by bdemann
Loading

Contributor

  • Code has been declaratized
  • All new functions have JSDoc/Rustdoc comments
  • Error handling beautiful (no unwraps or expects etc)
  • Code tested thoroughly
  • PR title:
    • Sentence cased
    • Described well for release notes
    • Indicates breaking changes with suffix "(breaking changes)"
  • Related issues have been linked and all tasks have been completed or made into separate issues
  • New documentation enumerated in the release issue
  • All breaking changes
    • Described below in the "Breaking Changes" section
    • Migration path described
  • Review is requested when ready

Reviewer

  • Code has been declaratized
  • All new functions have JSDoc/Rustdoc comments
  • Error handling beautiful (no unwraps or expects etc)
  • Code tested thoroughly
  • PR title:
    • Sentence cased
    • Described well for release notes
    • Indicates breaking changes with suffix "(breaking changes)"
  • Related issues have been linked and all tasks have been completed or made into separate issues
  • New documentation enumerated in the release issue
  • All breaking changes
    • Described below in the "Breaking Changes" section
    • Migration path described

Breaking Changes

All of the TypeScript and IDL types imported from azle/canisters/[canisterName] have been moved to azle/canisters/[canisterName]/idl. You can update your imports by simply adding idl to the end of the import path.

@lastmjs lastmjs linked an issue Feb 8, 2025 that may be closed by this pull request
Study azle/canisters and ensure it is the optimal API #2596
Closed
1 task
@lastmjs lastmjs changed the title change the paths of the canisters to idl directory Change azle/canisters/[canisterName] to azle/canisters/[canisterName]/idl Feb 8, 2025
@lastmjs lastmjs changed the title Change azle/canisters/[canisterName] to azle/canisters/[canisterName]/idl Change import paths azle/canisters/[canisterName] to azle/canisters/[canisterName]/idl (breaking changes) Feb 8, 2025
@lastmjs lastmjs marked this pull request as ready for review February 8, 2025 00:18
@lastmjs lastmjs requested a review from bdemann February 8, 2025 00:18
@lastmjs lastmjs merged commit 812b025 into main Feb 11, 2025
376 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bdemann bdemann bdemann approved these changes

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

Successfully merging this pull request may close these issues.

Study azle/canisters and ensure it is the optimal API
2 participants
@lastmjs @bdemann