In development release notes category #4953
Conversation
- the aim is to link merged PRs to WIP features so that every change is traceable to every release
CONTRIBUTING.md
Outdated
| @@ -61,6 +61,7 @@ Supported filename extensions are: | |||
|
|
|||
| - ``.feature``: Signifying a new feature in Element Android or in the Matrix SDK. | |||
| - ``.bugfix``: Signifying a bug fix. | |||
| - ``.dev``: Signifying a change which is not ready to be user facing, typically a component of a larger feature. | |||
There was a problem hiding this comment.
I'm not sure if .dev is the best extension might be a little too generic, what do people think?
There was a problem hiding this comment.
Maybe .wip since it's just an internal choose?
There was a problem hiding this comment.
sounds good to me 👍
37aadf4
CONTRIBUTING.md
Outdated
| @@ -61,6 +61,7 @@ Supported filename extensions are: | |||
|
|
|||
| - ``.feature``: Signifying a new feature in Element Android or in the Matrix SDK. | |||
| - ``.bugfix``: Signifying a bug fix. | |||
| - ``.dev``: Signifying a change which is not ready to be user facing, typically a component of a larger feature. | |||
| - ``.doc``: Signifying a documentation improvement. | |||
| - ``.removal``: Signifying a deprecation or removal of public API. Can be used to notifying about API change in the Matrix SDK | |||
There was a problem hiding this comment.
Maybe take the opportunity to create a .sdk extension, this one is not obvious at first sight.
There was a problem hiding this comment.
do we want to replace .removal with .sdk?
There was a problem hiding this comment.
.removal is available out of the box, so I decided to hack it and use it to log the SDK change (especially in the API). Maybe just add .sdk and start using it is enough. Also need to update https://github.com/vector-im/element-android/blob/main/towncrier.toml#L23
There was a problem hiding this comment.
if I understood correctly 7259324
if we want to keep the removal category is there a preferred section title?
There was a problem hiding this comment.
I think we will stop using .removal
Matrix SDKIntegration Tests Results:
|
Adds a new release notes category for in development code changes, this will help ensure all code changes can be related back to a release even if they're not user facing at the time of merge.
Draft output
Changes in Element 1 (2022-01-14)
Features ✨
Bugfixes 🐛
In development 🚧
SDK API changes⚠️
StateService.sendStateEvent()now takes a non-nullable String for the parameterstateKey. If null was used, just now use an empty string. (#4895)Other changes