From 5d3dd82363070867781c133acfa70cbc64a6bdac Mon Sep 17 00:00:00 2001 From: ricardoevvargas Date: Wed, 7 Dec 2022 17:27:24 -0300 Subject: [PATCH 1/2] Establish use of Semantic Versioning --- CONTRIBUTING.md | 6 ++++++ README.md | 17 +++++++++++++++++ dataset/dataset.ini | 2 +- toolkit/__init__.py | 2 +- 4 files changed, 25 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 624b8e89..deab4cc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,16 @@ [![Apache 2.0][apache-shield]][apache] [![CC BY 4.0][cc-by-shield]][cc-by] +[![Code style][black-shield]][black] +[![Versioning][semver-shield]][semver] [apache]: https://opensource.org/licenses/Apache-2.0 [apache-shield]: https://img.shields.io/badge/License-Apache_2.0-blue.svg [cc-by]: http://creativecommons.org/licenses/by/4.0/ [cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg +[black]: https://github.com/psf/black +[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg +[semver]: https://semver.org +[semver-shield]: https://img.shields.io/badge/semver-2.0.0-blue # Welcome to the 3W project contributing guide diff --git a/README.md b/README.md index 8a9da3c4..81b902ca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Apache 2.0][apache-shield]][apache] [![CC BY 4.0][cc-by-shield]][cc-by] [![Code style][black-shield]][black] +[![Versioning][semver-shield]][semver] [apache]: https://opensource.org/licenses/Apache-2.0 [apache-shield]: https://img.shields.io/badge/License-Apache_2.0-blue.svg @@ -8,6 +9,8 @@ [cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg [black]: https://github.com/psf/black [black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg +[semver]: https://semver.org +[semver-shield]: https://img.shields.io/badge/semver-2.0.0-blue # Table of Content @@ -76,6 +79,20 @@ It is also very important to know, participate and follow the discussions. See t All the code of this project is licensed under the [Apache 2.0 License][apache] and all 3W dataset data files (CSV files in the subdirectories of the [dataset](dataset) directory) are licensed under the [Creative Commons Attribution 4.0 International License][cc-by]. +## Versioning + +In the 3W project, three types of versions will be managed as follows. + +* Version of the 3W toolkit: specified in the [__init__.py](toolkit/__init__.py) file; +* Version of the 3W dataset: specified in the [dataset.ini](dataset/dataset.ini) file; +* Version of the 3W project: specified with tags in the git repository; +* We will exclusively use the semantic versioning defined in https://semver.org; +* Versions will always be updated manually; +* Versioning of the 3W toolkit and 3W dataset are completely independent of each other; +* The version of the 3W project will be updated whenever, and only when, there is a new commit in the `main` branch of the repository, regardless of the updated resource: 3W toolkit, 3W dataset, project documentation, example of use, etc; +* We will only use annotated tags and for each tag there will be a release in the remote repository (GitHub); +* Content for each release will be automatically generated with functionality provided by GitHub. + ## Questions See the discussions section. If you don't get clarification, please open discussions to ask your questions so we can answer them. diff --git a/dataset/dataset.ini b/dataset/dataset.ini index c3619f91..fe789c02 100644 --- a/dataset/dataset.ini +++ b/dataset/dataset.ini @@ -9,7 +9,7 @@ # [Versions] # 3W dataset version (may be different than 3W toolkit version) -DATASET = 1.0 +DATASET = 1.0.0 # This section defines descriptions of all columns of CSV data files # diff --git a/toolkit/__init__.py b/toolkit/__init__.py index 3a8bf50e..ee1b239e 100644 --- a/toolkit/__init__.py +++ b/toolkit/__init__.py @@ -47,7 +47,7 @@ """ __status__ = "Development" -__version__ = "1.0" +__version__ = "1.0.0" __license__ = "Apache License 2.0" __copyright__ = "Copyright 2022, Petróleo Brasileiro S.A." __authors__ = [ From 30587c4c9a22b025b1eeaca747f9412e3b8e91db Mon Sep 17 00:00:00 2001 From: ricardoevvargas Date: Wed, 7 Dec 2022 17:28:42 -0300 Subject: [PATCH 2/2] Fix TOC --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 81b902ca..a291bb86 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ * [Ambition](#ambition) * [Contributions](#contributions) * [Licenses](#licenses) + * [Versioning](#versioning) * [Questions](#questions) * [3W dataset](#3w-dataset) * [Structure](#structure)