Skip to content

Commit 131abd0

Browse files
add subsection about breaking changes
1 parent f976ebe commit 131abd0

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ pip install djls-agent
9999

100100
## Editor Setup
101101

102-
The Django Language Server should work with any editor that supports the Language Server Protocol (LSP). Got it working in your editor? [Help us add setup instructions](#testing-and-documenting-editor-setup)!
102+
The Django Language Server should work with any editor that supports the Language Server Protocol (LSP). Got it working in your editor? [Help us add setup instructions!](#testing-and-documenting-editor-setup)
103103

104104
- [Neovim](#neovim)
105105

@@ -168,6 +168,20 @@ In short, `v5.1.x` means the latest version of Django the Django Language Server
168168

169169
At this moment, all components of the Django Language Server (the `djls` binary, the `djls-agent` agent package on PyPI, and the `djls-binary` binary distribution package on PyPI) will share the same version number. When a new version is released, all packages are updated together regardless of which component triggered the release.
170170

171+
### Breaking Changes
172+
173+
While DjangoVer doesn't encode API stability in the version number, this project strives to follow Django's standard practice of "deprecate for two releases, then remove" policy for breaking changes. Given this is a language server, breaking changes should primarily affect:
174+
175+
- Configuration options (settings in editor config files)
176+
- CLI commands and arguments
177+
- LSP protocol extensions (custom commands/notifications)
178+
179+
The library will provide deprecation warnings where possible and document breaking changes clearly in release notes. For example, if a configuration option is renamed:
180+
181+
- v5.1.0: Old option works but logs deprecation warning
182+
- v5.1.1: Old option still works, continues to show warning
183+
- v5.1.2: Old option removed, only new option works
184+
171185
## Contributing
172186

173187
The project needs help in several areas:

0 commit comments

Comments
 (0)