Skip to content

Commit

Permalink
Add simple releasing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spenserblack authored Oct 22, 2024
1 parent d37f01b commit b987094
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Releasing

Releasing is a simple process -- just create a new GitHub release. Use the
auto-generate release notes feature, labelling PRs if necessary. The workflows should
take care of releasing to crates.io and making release assets.

## Versioning

### Major (breaking) changes to languages

These may not be obvious at first, as these are changes made to the data, not the Rust
code. The following changes to `languages.yaml` are considered breaking:

* Renaming a language
* Removing a language
* Removing a matcher (extension, interpreter, glob)[^1]

[^1]: An exception to this is if the matcher is so rarely used that it shouldn't have been added in the first place.

0 comments on commit b987094

Please sign in to comment.