SemVer policy + MSRV

Aberta
#26 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
44/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
rust
Domínio
documentation

Direção de pesquisa

Read the existing MSRV sections in README.md and the linked Rust API Guidelines discussion to understand the proposed policy. Replace those sections with a SemVer Policy section that states how MSRV changes are treated; done means the README gives contributors a clear policy to reference. The issue has had no activity for over a year, so check whether the policy is still wanted before starting.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Coming from https://github.com/RustCrypto/password-hashes/issues/627

I think it would make sense to replace the old MSRV sections of our README.md with a new "SemVer Policy" section which lists MSRV as being out-of-scope, possibly highlighting https://github.com/rust-lang/api-guidelines/discussions/231

Without it, I worry people will say MSRV changes are a breaking change (even if that's wrong), so it would be nice to have something to point to in the README saying MSRV changes don't violate our SemVer policy.

Linguagem predominante
Sem dados de linguagem
Estrelas
13
Forks
4
Merge médio
41min
PRs com merge (30d)
1

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de RustCrypto/meta

Todas as issues de RustCrypto/meta

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.