Skip to content

Commit

Permalink
Add temporary warning about edition change
Browse files Browse the repository at this point in the history
This warns contributors about possible rebases. Changing CONTRIBUTING
should ensure that GitHub will display special warning. This will be
removed after migration is done.
  • Loading branch information
Kixunil committed Apr 20, 2022
1 parent 8f899c7 commit bd36d84
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
</p>
</div>

**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/)

Expand Down

0 comments on commit bd36d84

Please sign in to comment.