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

(MAJOR) Prepare for stable API (1.0) release #151

Merged
merged 2 commits into from
Dec 19, 2022
Merged

Conversation

scouten-adobe
Copy link
Member

I believe that this crate is ready for API stabilization.

I'm seeking discussion regarding committing to the existing API as a stable interface over the next month. Barring unresolved feedback, this PR will be merged on 5 December 2022 and a 1.0 release issued at that time.

Between now and then, I welcome feedback on any issues or concerns that should block or delay a 1.0 release. Please review this crate and remaining APIs from the underlying C++ XMP Toolkit with an eye toward what might cause breaking API changes.

I believe the following are not in scope for 1.0 release:

  • Porting remaining APIs from XMP_Meta, XMP_Files, and TXMPUtils. (There are relatively few left and these may be added in 1.x releases.)
  • Porting UTF-16 or UTF-32 APIs.
  • Porting other APIs (notably the I___ API surface).

Please either file issues here in GitHub or add comments to this PR while discussion is open.

@scouten-adobe scouten-adobe self-assigned this Nov 6, 2022
@codecov
Copy link

codecov bot commented Nov 6, 2022

Codecov Report

Merging #151 (29d0b11) into main (f48342f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #151   +/-   ##
=======================================
  Coverage   97.87%   97.87%           
=======================================
  Files           8        8           
  Lines        1504     1504           
=======================================
  Hits         1472     1472           
  Misses         32       32           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

# Conflicts:
#	README.md
@scouten-adobe scouten-adobe merged commit 7cf5ee4 into main Dec 19, 2022
@scouten-adobe scouten-adobe deleted the stable-api branch December 19, 2022 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant