Browse Source

Formalize release process

pull/1/head
Leonora Tindall 8 months ago
parent
commit
dd2102d973
Signed by: nora <nora@nora.codes> GPG Key ID: 7A8B52EC67E09AAF
2 changed files with 12 additions and 2 deletions
  1. +2
    -2
      CHANGELOG.md
  2. +10
    -0
      CONTRIBUTING.md

+ 2
- 2
CHANGELOG.md View File

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased - 0.2.0
## Unreleased - v0.2.0

### Added

@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Security

## 0.1.0
## v0.1.0
### Added

- GNU GPL v3 license


+ 10
- 0
CONTRIBUTING.md View File

@@ -17,3 +17,13 @@ CHANGELOG.md.

All method documentation is written in the present tense. For example, "Creates a new..."
rather than "Create a new...".

## Cutting a Release

When cutting a release:

- In CHANGELOG, rename the Unreleased section and add a new Unreleased section above it
- Make a commit with only that change
- Tag that commit like "v1.0.0"
- Push main and the tag
- `cargo publish`

Loading…
Cancel
Save