Repository navigation
Document what is considered part of the supported API and what constitutes a breaking change #1874
Description
Activity
I was just being very unclear there in my wording sorry. :/ I didn't mean anything to do with the changelog or releases in there 🙇
I was just being very unclear there in my wording sorry. :/ I didn't mean anything to do with the changelog or releases in there 🙇
Or maybe it is my reading comprehension!
It still might be good for us to document it anyway as what we agree to not change unless it is a major-release breaking change. No rush, but something to have an issue about.
This issue was marked stale because it has been open 60 days with
no activity. Please remove the stale label or comment on this
issue. Otherwise, it will be closed in 15 days.As an open-source project, we rely on community contributions to
address many of the reported issues. Without a proposed fix or
active work towards a solution it is our policy to close inactive
issues. This is documented in CONTRIBUTING.rstHow to keep this issue open:
- If you are still experiencing this issue and are willing to
investigate a fix, please comment and let us know. - If you (or someone else) can propose a pull request with a
solution, that would be fantastic. - Any significant update or active discussion indicating progress
will also prevent closure.
We value your input. If you can help provide a fix, we'd be happy
to keep this issue open and support your efforts.This is documented in CONTRIBUTING.rst
https://github.com/python-gitlab/python-gitlab/blob/main/CONTRIBUTING.rst- If you are still experiencing this issue and are willing to
- locked as resolved and limited conversation to collaborators on Jul 13, 2026
We need to explicitly declare what part of our API is considered for public consumption and thus we will not break that API unless it is done in a major release "breaking change".
Also state that things not covered by the public API are not covered by that promise and usage of them is subject to change at anytime.