Versions Compared

Old Version 13

changes.mady.by.user Vijay Kumar

Saved on

compared with

New Version 14

changes.mady.by.user Tony Hansen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • is there a LICENSE.txt file?
  • All code modules should have comments at the beginning that look like:

# ================================================================================
# Copyright (c) 2017-2020 Company1. All rights reserved.
# Copyright (c) 2020 Company2. All rights reserved.
# Copyright (c) 2020 Company3. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================


  • All documentation files should have comments at the beginning that look like:

.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (c) 2017-2020 Company1. All rights reserved.

  • Does it mention the current year for the company doing the modification?
  • Note that there is no separator between Copyright lines by different companies.
  • Note that the word "Copyright" is capitalized.
  • Note that when a company updates code that was previously copyrighted by them, the date range should be extended as shown.
  • There is no alternate wording for the copyright lines, such as "modifications copyrightModifications Copyright"

Check for comments in all new code

...

An example of a Changelog is:

(https://jira.onap.org/browse/DCAEGEN2-2885) (https://jira.onap.org/browse/DCAEGEN2-2811)

# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.0.6] - 2021/08/28
### Changed
         - [DCAEGEN2-2885]

- DCAE SliceAnalysis MS - CPS Integration
### Removed
         - [DCAEGEN2-2811]

- Remove security vulnerabilities

. . .

As committers, some of the things you should always check are:

...