Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

CORTX-33703- codacy cleanup: Fixed codacy formatting issues #2055

Merged
merged 3 commits into from
Aug 16, 2022
Merged

CORTX-33703- codacy cleanup: Fixed codacy formatting issues #2055

merged 3 commits into from
Aug 16, 2022

Conversation

@pratik-patil-5611
Copy link
Contributor

@pratik-patil-5611 pratik-patil-5611 commented Aug 5, 2022 •
edited
Loading

Signed-off-by: Pratik Patil [email protected]

Problem Statement

  • Codacy warnings in below given files:
    • [fenced-code-flag]
      • doc/ADDB_Monitoring.md
      • doc/CORTX-MOTR-ARCHITECTURE.md
      • doc/FOPFOM-Programming-Guide.md
      • doc/HLD-OF-Motr-LNet-Transport.md
      • doc/HLD-of-Catalogue-Service.md
      • doc/HLD-of-Motr-Object-Index.md
      • doc/ISC-Service-User-Guide.md
      • doc/Motr-Epochs-HLD.md
      • doc/Motr-Lnet-Transport.md
      • doc/motr-kv-app.md
      • doc/motr-object-app.md
    • [ordered-list-marker-value]
      • doc/ADDB_Monitoring.md
      • doc/Running_Motr_Across_a_Cluster.md
    • [heading-style] Headings should use atx or atx-closed
      • doc/CORTX-MOTR-ARCHITECTURE.md
      • doc/HLD-FOP-State-Machine.md
      • doc/HLD-Resource-Management-Interface.md
      • doc/HLD-of-FOL.md
      • doc/HLD-of-Motr-Lostore.md
      • doc/HLD-of-Motr-Network-Benchmark.md
      • doc/HLD-of-Motr-Object-Index.md
      • doc/HLD-of-Motr-Spiel-API.md
      • doc/Seagate-FDMI-HLD.md
    • [no-heading-content-indent]
      • doc/CORTX-MOTR-ARCHITECTURE.md
      • doc/HLD-FOP-State-Machine.md
      • doc/HLD-Resource-Management-Interface.md
      • doc/HLD-of-Catalogue-Service.md
      • doc/HLD-of-FOL.md
      • doc/HLD-of-Motr-Lostore.md
      • doc/HLD-of-Motr-Network-Benchmark.md
      • doc/HLD-of-Motr-Spiel-API.md
      • doc/ISC-Service-User-Guide.md
    • [emphasis-marker]
      • scripts/provisioning/README.md

Design

  • [fenced-code-flag] -> added name of programming language after 3 backquotes ```
  • [ordered-list-marker-value] -> marker changed to correct numeric
  • [heading-style] -> used atx or atx-closed formatting for headings
  • [no-heading-content-indent] -> removed 1 space after this heading’s content
  • [emphasis-marker] -> added * before and after the word to be emphasized

Coding

Checklist for Author

  • Coding conventions are followed and code is consistent

Testing

Checklist for Author

  • Unit and System Tests are added
  • Test Cases cover Happy Path, Non-Happy Path and Scalability
  • Testing was performed with RPM

Impact Analysis

Checklist for Author/Reviewer/GateKeeper

  • Interface change (if any) are documented
  • Side effects on other features (deployment/upgrade)
  • Dependencies on other component(s)

Review Checklist

Checklist for Author

  • JIRA number/GitHub Issue added to PR
  • PR is self reviewed
  • Jira and state/status is updated and JIRA is updated with PR link
  • Check if the description is clear and explained

Documentation

Checklist for Author

  • Changes done to WIKI / Confluence page / Quick Start Guide

View rendered doc/ADDB_Monitoring.md
View rendered doc/CORTX-MOTR-ARCHITECTURE.md
View rendered doc/HLD-FOP-State-Machine.md
View rendered doc/HLD-Resource-Management-Interface.md
View rendered doc/HLD-of-Catalogue-Service.md
View rendered doc/HLD-of-FOL.md
View rendered doc/HLD-of-Motr-Lostore.md
View rendered doc/HLD-of-Motr-Network-Benchmark.md
View rendered doc/HLD-of-Motr-Object-Index.md
View rendered doc/HLD-of-Motr-Spiel-API.md
View rendered doc/ISC-Service-User-Guide.md
View rendered doc/Running_Motr_Across_a_Cluster.md
View rendered scripts/provisioning/README.md

@cla-bot
Copy link

cla-bot bot commented Aug 5, 2022

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Pratik Patil.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email [email protected]
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

@rkothiya
Copy link
Contributor

rkothiya commented Aug 5, 2022

Can one of the admins verify this patch?

@cla-bot
Copy link

cla-bot bot commented Aug 8, 2022

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Pratik Patil.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email [email protected]
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

@cla-bot cla-bot bot added the cla-signed label Aug 8, 2022
@pratik-patil-5611
CORTX-33703: Fixed formatting issues in following files
31f56e4 
doc/HLD-of-Motr-Network-Benchmark.md
doc/HLD-of-FOL.md
doc/HLD-of-Motr-Spiel-API.md
doc/HLD-of-Motr-Object-Index.md
scripts/provisioning/README.md
doc/Running_Motr_Across_a_Cluster.md
doc/CORTX-MOTR-ARCHITECTURE.md
doc/HLD-of-Motr-Lostore.md
doc/HLD-of-Catalogue-Service.md
doc/HLD-FOP-State-Machine.md
doc/ADDB_Monitoring.md
doc/HLD-Resource-Management-Interface.md
doc/ISC-Service-User-Guide.md

Signed-off-by: Pratik Patil <[email protected]>
@hessio hessio added codacy Status: Waiting to be Reviewed PR is waiting for reviewers to review the PR labels Aug 9, 2022
@pratik-patil-5611 pratik-patil-5611 force-pushed the test branch 3 times, most recently from 244bc77 to ba8051a Compare August 12, 2022 05:19
@pratik-patil-5611 pratik-patil-5611 force-pushed the test branch 2 times, most recently from 8ae4a99 to 634ef8f Compare August 12, 2022 09:50
rkothiya
rkothiya approved these changes Aug 16, 2022
View reviewed changes
Copy link
Contributor

@rkothiya rkothiya left a comment

Choose a reason for hiding this comment

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

LGTM

@rkothiya
Copy link
Contributor

rkothiya commented Aug 16, 2022

Giving an exception to the documentation changes.

@rkothiya rkothiya added the Exception Allowed to merge without runing ut and st label Aug 16, 2022
@rkothiya rkothiya merged commit d7da706 into Seagate:main Aug 16, 2022
@pratik-patil-5611 pratik-patil-5611 deleted the test branch August 18, 2022 09:47
kiwionly2 pushed a commit to kiwionly2/cortx-motr that referenced this pull request Aug 30, 2022
@pratik-patil-5611 @kiwionly2
CORTX-33703: Fixed codacy issues in documentation (Seagate#2055)
2a48712 
Warnings and their solutions :
 
[fenced-code-flag] -> added name of programming language after 3 backquotes ```
[ordered-list-marker-value] -> marker changed to correct numeric
[heading-style] -> used atx or atx-closed formatting for headings
[no-heading-content-indent] -> removed 1 space after this heading’s content
[emphasis-marker] -> added * before and after the word to be emphasized

Signed-off-by: Pratik Patil <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@mehjoshi mehjoshi Awaiting requested review from mehjoshi

@madhavemuri madhavemuri Awaiting requested review from madhavemuri

@nikitadanilov nikitadanilov Awaiting requested review from nikitadanilov

@yeshpal-jain-seagate yeshpal-jain-seagate Awaiting requested review from yeshpal-jain-seagate

@huanghua78 huanghua78 Awaiting requested review from huanghua78

@andriytk andriytk Awaiting requested review from andriytk andriytk is a code owner

@siningwuseagate siningwuseagate Awaiting requested review from siningwuseagate siningwuseagate is a code owner

@vidyadhar-pinglikar vidyadhar-pinglikar Awaiting requested review from vidyadhar-pinglikar

@shashank-parulekar shashank-parulekar Awaiting requested review from shashank-parulekar

@nkommuri nkommuri Awaiting requested review from nkommuri nkommuri is a code owner

@sg-shankar sg-shankar Awaiting requested review from sg-shankar

@yatin-mahajan yatin-mahajan Awaiting requested review from yatin-mahajan

2 more reviewers

@rkothiya rkothiya rkothiya approved these changes

@anaghadeshmukh anaghadeshmukh anaghadeshmukh approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nikitadanilov nikitadanilov

@madhavemuri madhavemuri

@mehjoshi mehjoshi

Labels

cla-signed codacy Exception Allowed to merge without runing ut and st Status: Waiting to be Reviewed PR is waiting for reviewers to review the PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@pratik-patil-5611 @rkothiya @anaghadeshmukh @nikitadanilov @madhavemuri @hessio @mehjoshi