From bd36d846f29c495ce8196f32d49b13c74c136b22 Mon Sep 17 00:00:00 2001 From: Martin Habovstiak Date: Wed, 20 Apr 2022 20:15:49 +0200 Subject: [PATCH] Add temporary warning about edition change This warns contributors about possible rebases. Changing CONTRIBUTING should ensure that GitHub will display special warning. This will be removed after migration is done. --- CONTRIBUTING.md | 6 ++++++ README.md | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36758802..81d182d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ # Contributing to rust-bitcoin +**Heads up about upcoming edition change** + +We're currently preparing to bump MSRV and **change the edition to 2018**. +To minimize the churn we recommend you to submit your local WIP changes ASAP. +There will be a lot of rebasing after the edition change. + :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: The following is a set of guidelines for contributing to Rust Bitcoin diff --git a/README.md b/README.md index f3c0a458..c01077b2 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,11 @@

+**Heads up for contributors: upcoming edition change** + +We're currently preparing to bump MSRV and **change the edition to 2018**. +To minimize the churn we recommend you to submit your local WIP changes ASAP. +There will be a lot of rebasing after the edition change. [Documentation](https://docs.rs/bitcoin/)