From ab5738d423b54af468c0e854c5e103d0de4e3d49 Mon Sep 17 00:00:00 2001 From: Renan <6718144+renancaraujo@users.noreply.github.com> Date: Thu, 5 Oct 2023 10:45:48 +0100 Subject: [PATCH] docs: add release docs (#92) --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index caa8a6b..5db591f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,3 +37,14 @@ While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. + +## Releasing new versions + +Every snapshot of a version is saved on its own yaml file under the name pattern: `lib/analysis_options..yaml`. + +To release a new version: + +1. Copy the most recent yaml to a new one with the new desired version. +1. Include that file on the main yaml file `lib/analysis_options.yaml`. +1. Open a pull request with the proposed changes. +