Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comment blocks #1917

Merged
merged 4 commits into from
Oct 26, 2022
Merged

Add comment blocks #1917

merged 4 commits into from
Oct 26, 2022

Conversation

NakuraMino
Copy link
Contributor

@NakuraMino NakuraMino commented Oct 26, 2022

Motivation and Context

Some files don't have the copyright comment block at the top of the file. This PR is to update the source code files to include those comment blocks.

(Also realized my previous pr only changed the comment blocks for python files, so i'm including updates to other files in this PR too).

How Has This Been Tested

since we are only updating comments, no tests except for the CI/CD tests are needed.

We can verify that the old copyright block is gone by querying grep -rw -e 'Copyright (c) Facebook, Inc.' and verifying that the resulting files are 1.) non-editable (e.g. binary files) or are excluded from the repo via .gitignore.

We can verify that all necessary files have a copyright by querying

grep -rL "Copyright" --exclude-dir='.git' --exclude='*.ipynb' --exclude='*.navmesh' --exclude='*.glb' --exclude='*.md' --exclude='*.txt' --exclude='*.yaml' --exclude='*.pyc' --exclude='*.json*' --exclude='*.gif' --exclude='*.png' --exclude='*nb_python*' --exclude='*.rst' --exclude='*.yml' --exclude='*.cfg' --exclude='*.gitignore*' --exclude='*.in'--exclude='*.toml' --exclude='*.in' --exclude='*.ini' --exclude='*Dockerfile*' --exclude='.editorconfig' --exclude='*EGG-INFO*' --exclude='*deps/*' --exclude='*build/*' --exclude='*.jpg' --exclude='*.gltf' --exclude='*.stl' --exclude='*m.css*' --exclude='*.bin' --exclude='*.urdf' --exclude='*.npy' --exclude='*.inv' --exclude='*.ansi' --exclude='*.mp4'

and check that the resulting file list are not code files or are from third party (e.g. /src_python/habitat_sim/logging.py)

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Oct 26, 2022
Copy link
Contributor

@aclegg3 aclegg3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the thoroughness. 👍

@NakuraMino NakuraMino merged commit 5fb0407 into main Oct 26, 2022
@NakuraMino NakuraMino deleted the add_comment_blocks branch October 26, 2022 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants