AnimeFunsion/modular-avatar
1
0
Fork 0
mirror of https://github.com/bdunderscore/modular-avatar.git synced 2024-12-29 18:55:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add notes on NDMF pass versioning policy (#612)

Browse Source
This commit is contained in:
bd_ 2024-01-07 15:18:33 +09:00 committed by GitHub
parent 7430996adc
commit 1d6a1634db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs~/docs/distributing-prefabs/versioning-policy.md
View File

@ -10,4 +10,13 @@ Modular Avatar subscribes to [Semantic Versioning](https://semver.org/). This me
* When new features are added in a backwards compatible way, the second component of the version number will change (e.g. 1.0.0 -> 1.1.0). Prefabs made with e.g. 1.1.0 may not work on 1.0.0, but prefabs made with 1.0.0 will work with 1.1.0.
* When minor bugfixes and other changes that don't affect save format are made, the third component will change (1.0.0 -> 1.0.1). Unless the bug fix affects your prefab, generally using an older patch version should not be a large issue.
In general, using the latest version of modular avatar under the same major version (1.x.x) is recommended.
In general, using the latest version of modular avatar under the same major version (1.x.x) is recommended.
## Internals and pass references
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.
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.

12
docs~/i18n/ja/docusaurus-plugin-content-docs/current/distributing-prefabs/versioning-policy.md
View File

@ -6,4 +6,14 @@
* 互換性のある新機能が追加された場合は、バージョン番号の2番目の数字が変わります (例: 1.0.0 -> 1.1.0)。例えば1.1.0で作られたアセットは1.0.0では動作しないかもしれませんが、1.0.0で作られたアセットは1.1.0で動作します。
* バグ修正やセーブフォーマットに影響のない変更が入った場合は、バージョン番号の3番目の数字が変わります (1.0.0 -> 1.0.1)。バグ修正がアセットに影響を与えない限り、古いパッチバージョンを使うことは問題にはならないでしょう。
原則として、同じメジャーバージョン（1.x.xなど）の中で最新版を使うことをお勧めします。
原則として、同じメジャーバージョン（1.x.xなど）の中で最新版を使うことをお勧めします。
## internal関数とパス引用
`internal`指定のクラス・関数名などは安定APIとして扱わないため、いつでも変更される可能性があります。パッチリリース（1.0.0 ->
1.0.1）
でも変更される可能性があるのでご注意ください。また、NDMFパスの「qualified name」も安定APIとして扱わないし、その順番もまた予告なく
変更となる可能性があります。
Modular Avatar内部のパスを引用するユースケースがある場合は、githubで詳しいユースケースを機能リクエストを出してください。
安定APIとして追加することを検討します。