Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
serjsysoev committed Apr 26, 2024
1 parent 7d43b3b commit f853857
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Changelog

Version 25.0.0
---
* Added Kotlin Multiplatform artifact (multiplatform-annotations).
* Removed Java 5 artifact.

Version 24.1.0
Expand Down
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ During the new version release:
* Push changes
* Use 'Draft a new release' button on the Releases GitHub page; select the added tag; copy it to the release title
field; copy the added changelog section into the release details field.


### Multiplatform artifact
We publish two artifacts: annotations (annotations written in Java) and multiplatform-annotations (same annotations
written in Kotlin Multiplatform). Please check that changes are done both in java-annotations and
multiplatform-annotations folders. Jvm artifact of multiplatform-annotations should be a drop-in replacement of
java-annotations, every annotation added to java-annotations should also be added to multiplatform-annotations.

### Backward compatibility
All the changes should be backward compatible i.e. you can only add new annotations and new elements into existing annotation.
If it's absolutely necessary to remove an annotation or its element we must firstly release a new major version where
Expand Down

0 comments on commit f853857

Please sign in to comment.