document version policy
This commit is contained in:
parent
45081efd0e
commit
4192d37854
2 changed files with 31 additions and 2 deletions
|
@ -25,7 +25,7 @@ xdg-mime-backend = ["xdg-mime"]
|
||||||
json = ["serde", "serde_json"]
|
json = ["serde", "serde_json"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
walkdir = "2.3.2"
|
walkdir = "~2.3.2"
|
||||||
log = "0.4.14"
|
log = "0.4.14"
|
||||||
mime = "0.3.16"
|
mime = "0.3.16"
|
||||||
mime_guess = { package = "new_mime_guess", features = ["phf-map"], version = "3.0.0" }
|
mime_guess = { package = "new_mime_guess", features = ["phf-map"], version = "3.0.0" }
|
||||||
|
|
31
README.md
31
README.md
|
@ -8,7 +8,7 @@
|
||||||
[![Version](https://img.shields.io/crates/v/fif.svg?logo=rust&style=flat-square)
|
[![Version](https://img.shields.io/crates/v/fif.svg?logo=rust&style=flat-square)
|
||||||
](https://crates.io/crates/fif)
|
](https://crates.io/crates/fif)
|
||||||
[![Minimum Supported Rust Version](https://img.shields.io/badge/msrv-1.43.0-orange?logo=rust&style=flat-square)
|
[![Minimum Supported Rust Version](https://img.shields.io/badge/msrv-1.43.0-orange?logo=rust&style=flat-square)
|
||||||
](https://crates.io/crates/fif)
|
](https://gitlab.com/Lynnesbian/fif/-/blob/master/README.md#version-policy)
|
||||||
[![License](https://img.shields.io/crates/l/fif.svg?style=flat-square)
|
[![License](https://img.shields.io/crates/l/fif.svg?style=flat-square)
|
||||||
](https://gitlab.com/Lynnesbian/fif/-/blob/master/LICENSE)
|
](https://gitlab.com/Lynnesbian/fif/-/blob/master/LICENSE)
|
||||||
[![Build status](https://img.shields.io/gitlab/pipeline/Lynnesbian/fif/master?logo=gitlab&style=flat-square)
|
[![Build status](https://img.shields.io/gitlab/pipeline/Lynnesbian/fif/master?logo=gitlab&style=flat-square)
|
||||||
|
@ -187,3 +187,32 @@ a more concise overview).
|
||||||
[`xdg-mime`]: https://crates.io/crates/xdg-mime
|
[`xdg-mime`]: https://crates.io/crates/xdg-mime
|
||||||
[`infer`]: https://crates.io/crates/infer
|
[`infer`]: https://crates.io/crates/infer
|
||||||
[Shared MIME Info]: https://gitlab.freedesktop.org/xdg/shared-mime-info/
|
[Shared MIME Info]: https://gitlab.freedesktop.org/xdg/shared-mime-info/
|
||||||
|
|
||||||
|
|
||||||
|
## Version policy
|
||||||
|
fif adheres to the [semantic versioning](https://semver.org/) principles. While fif remains at version 0.x, the version
|
||||||
|
number will be updated as follows:
|
||||||
|
- The MAJOR version will be bumped to 1 when I believe fif to be "feature complete".
|
||||||
|
- The MINOR version will be bumped whenever I add a fairly important feature to fif (in the past, this has been bumped
|
||||||
|
when adding the ability to exclude extensions, and when fif gained the ability to output a bash script rather than a
|
||||||
|
list of invalid filenames). The MINOR version will also be bumped when increasing the MSRV.
|
||||||
|
- The PATCH version will be bumped in all other cases, including minor feature additions (in the past, this has occurred
|
||||||
|
when adding features such as more output formats and the ignore flag).
|
||||||
|
|
||||||
|
If/when fif hits version 1.0, these rules will likely remain the same as they are now.
|
||||||
|
|
||||||
|
## License
|
||||||
|
Copyright (C) 2021 Lynnesbian
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
Loading…
Reference in a new issue