chore(docs): clarify NDMF versioning policy

This commit is contained in:
bd_ 2024-02-20 20:01:18 +09:00
parent a86e28a037
commit 9e5e75676c
2 changed files with 4 additions and 2 deletions

View File

@ -16,7 +16,8 @@ In general, using the latest version of modular avatar under the same major vers
All `internal` class names and method names are not considered stable APIs and are subject to change at any time,
including patch releases (1.0.0 -> 1.0.1). In particular, the "qualified name" of NDMF passes is also not considered
API stable, nor is the order in which Modular Avatar passes will run.
API stable, nor is the order in which Modular Avatar passes will run. The "Qualified Name" of the plugin itself,
`nadena.dev.modular-avatar`, is however considered stable and will not change.
If you have a use case for depending on specific Modular Avatar passes, please file a feature request with details of
your use case on the github, and I'll consider adding a stable API for adding those pass dependencies.

View File

@ -13,7 +13,8 @@
`internal`指定のクラス・関数名などは安定APIとして扱わないため、いつでも変更される可能性があります。パッチリリース1.0.0 ->
1.0.1
でも変更される可能性があるのでご注意ください。また、NDMFパスの「qualified name」も安定APIとして扱わないし、その順番もまた予告なく
変更となる可能性があります。
変更となる可能性があります。ただし、プラグイン自体の「qualified name」である`nadena.dev.modular-avatar`は安定APIとして扱い、
今後変更されません。
Modular Avatar内部のパスを引用するユースケースがある場合は、githubで詳しいユースケースを機能リクエストを出してください。
安定APIとして追加することを検討します。