New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document our policy for minimum supported Rust versions and when they can be bumped #1576

Open
sgrif opened this Issue Feb 26, 2018 · 3 comments

Comments

Projects
None yet
2 participants
@sgrif
Member

sgrif commented Feb 26, 2018

This has been discussed internally some, but we should figure out the right place to document it. Last time we discussed it, we decided the following:

  • Bumping the minimum Rust version is not considered a major breaking change.
  • The minimum version should only be bumped if we have a good reason
    • Convenience/cleaning up code is not a good reason

I think we should also add to the policy that we will not bump the minimum Rust version in a patch version of Diesel.

/cc @diesel-rs/core Does that sound about right?

I think we should probably document this in two places. One for users, and one for contributors. For the user-facing docs, perhaps the top of the changelog is a good place to document it? Right after where we specify our semver policy, we could add: "Increasing the minimum supported version of Rust is not considered a breaking change, but it will only be done in major or minor versions.".

For contributors I think we need to say something like "It is ok to increase the minimum supported version of Rust, but only if it is required to implement your feature. If it is possible to implement without relying on more recent features, you should do so". I have no clue where we'd document that.

We should also probably figure out what our current minimum supported version is and add it to the test matrix (maybe only check that things compile, don't need another full run)

@tcmal

This comment has been minimized.

tcmal commented Apr 23, 2018

It seems like this is already being done with nightly-2018-02-02, Just tried compiling with nightly-2018-02-01 and it failed with can't find crate for 'rustc_const_eval' (clippy-lints).

@sgrif

This comment has been minimized.

Member

sgrif commented Apr 23, 2018

That's an irrelevant error, the version of clippy we use is tied to a specific nightly, and isn't expected to work with other versions.

@tcmal

This comment has been minimized.

tcmal commented Apr 23, 2018

Ah, my bad.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment