Orange-OpenSource / its-client

This Intelligent Transportation Systems (ITS) MQTT client based on the JSon ETSI specification transcription provides a ready to connect project for the mobility (connected and autonomous vehicles, road side units, vulnerable road users,...). Let's connect your device or application to our Intelligent Transport Systems (ITS) platform!
MIT License
7 stars 8 forks source link

Fix source code headers (project name, licence, year,...) #160

Closed tigroo closed 1 month ago

tigroo commented 1 month ago

e.g.:

/*
 * Software Name : libits
 * SPDX-FileCopyrightText: Copyright (c) Orange SA
 * SPDX-License-Identifier: MIT
 *
 * This software is distributed under the MIT license,
 * see the "LICENSE.txt" file for more details or https://opensource.org/license/MIT/
 *
 * Authors: see CONTRIBUTORS.md
 * Software description: This Intelligent Transportation Systems (ITS) [MQTT](https://mqtt.org/) library based on the [JSon](https://www.json.org) [ETSI](https://www.etsi.org/committee/its) specification transcription provides a ready to connect project for the mobility (connected and autonomous vehicles, road side units, vulnerable road users,...).
 */

into telemtry.rs (not into libits) and a out of context Software description.

nbuffon commented 1 month ago

The header is valid against the Orange Open Source recommendations (https://infoportal-opensource.innov.intraorange/en/copyright-and-license-notices/)

I don't understand the telemetry.rs remark The software name is actually mistaken, as it should match the built artifact's name, here libits-client as it is the name of the library pushed in crates.io I'll fix it

About the software description, same, it should match the whole "product" description, but it is optional, it can be removed from the header...