Skip to content
This repository was archived by the owner on Oct 12, 2023. It is now read-only.

Conversation

@karanasthana
Copy link

@karanasthana karanasthana commented Apr 18, 2022

What does this change do? Please be clear and concise.

Adds a logging mechanism to every run of m3c-tools.

Why was this change made? Including an issue number is sufficient. Otherwise, briefly explain the benefit of the change.

https://jira-prod.ctsi.ufl.edu/browse/M3C-193
Benefit of this change - adds all logs to one place, easier to analyze

Verification

List the steps needed to make sure this thing works. Be precise.

  1. From the command-line, run ...
  2. The output should look like this: ...
  3. If you pass some bad value, the output should look like this: ...
  4. ...
  • Verify the thing does this: ...
  • Verify the thing does not do that: ...

Affirmations

All of these should have a check by them. Any exception requires an explanation.

  • I matched the style of the existing code.
  • I added and updated any relevant documentation (inline, README, CHANGELOG, and such).
  • I used Python's type hinting.
  • I ran the automated tests and ensured they ALL passed.
  • I ran the linter and ensured my changes have not introduced ANY warnings or errors.
  • I have made an effort to minimize code changes and have not included any cruft (preference files, *.pyc files, old comments, print-debugging, unused variables).
  • I have made an effort maintain a clear commit history (haven't merged other branches or rebased improperly).
  • I have written the code myself or have given credit where credit is due.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants