Welcome to the NVDA Add-on API mailing list

[NVDA Add-on API Announcements]

Welcome to the NVDA Add-on API mailing list.

There are currently no API breaking changes staged for 2023.1.
Any introduction of breaking changes will be announced via this mailing list.

In 2022.4, we will be including a summary of the NVDA core API policy in the NVDA developer guide.
This is the policy that is already in affect, it is being written down so that it accessible from a central and translatable location.
Any changes to this policy will be conveyed via this mailing list and the NVDA changes file.
For those unaware or new to NVDA development, the policy is as follows:

The NVDA API only includes symbols which are not marked with prefixing underscores.
The NVDA Add-on API changes over time, such as removals, deprecations and new features.

API breaking releases happen at most once per year, these are .1 releases, e.g. 2022.1.
The API remains backwards compatible between breaking releases.
API breaking changes should be considered relatively stable in the first beta: e.g. 2022.1.beta1.

API features may become deprecated over time.
Deprecated API features may have a scheduled removal date, a future breaking release (e.g. 2022.1).
Deprecations may also have no scheduled removal date, and will remain supported until it is no longer reasonable.
Note, the roadmap for removals is 'best effort' and may be subject to change.
Please open a GitHub issue if the described add-on API changes result in the API no longer meeting the needs of an add-on you develop or maintain.

Kind Regards,
NV Access Software Developers