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

pre-commit hook description added to documentation. #442

Merged
merged 7 commits into from
Oct 17, 2023

Conversation

deadkittten
Copy link
Contributor

Description

  • pre-commit hook description added to documentation.

How has this been tested?

  • no code has been changed. Documentations correction only.

pre-commit file body and description added.
pre-commit description added to install.rst
@deadkittten deadkittten requested a review from a team as a code owner October 17, 2023 07:49
babenek
babenek previously approved these changes Oct 17, 2023
Copy link
Contributor

@babenek babenek left a comment

Choose a reason for hiding this comment

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

Thank you for adding sample of pre-commit script which compatible with linux and windows!

@codecov-commenter
Copy link

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (48bbc37) 90.83% compared to head (4d882fd) 90.83%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #442   +/-   ##
=======================================
  Coverage   90.83%   90.83%           
=======================================
  Files         125      125           
  Lines        4168     4168           
  Branches      659      659           
=======================================
  Hits         3786     3786           
  Misses        251      251           
  Partials      131      131           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/source/install.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@csh519 csh519 left a comment

Choose a reason for hiding this comment

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

Please check my comments.

docs/source/install.rst Outdated Show resolved Hide resolved
docs/source/install.rst Outdated Show resolved Hide resolved
docs/source/install.rst Outdated Show resolved Hide resolved
deadkittten and others added 2 commits October 17, 2023 12:10
Co-authored-by: ShinHyung Choi <[email protected]>
Co-authored-by: ShinHyung Choi <[email protected]>
docs/source/install.rst Outdated Show resolved Hide resolved
Agree. See comments upper.

Co-authored-by: Roman Babenko <[email protected]>
@babenek babenek requested review from csh519 and babenek October 17, 2023 09:23
Copy link
Contributor

@babenek babenek left a comment

Choose a reason for hiding this comment

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

Okay,
only added credentials will block commit.
However, there is comprehensive information in capital letters.
Thank you

Copy link
Collaborator

@csh519 csh519 left a comment

Choose a reason for hiding this comment

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

pre-commit hook description added.

LGTM 👍

@babenek babenek merged commit af2eb84 into Samsung:main Oct 17, 2023
babenek added a commit to babenek/CredSweeper that referenced this pull request Oct 18, 2023
* pre-commit description added to install.rst

pre-commit file body and description added.

* Update docs/source/install.rst

* Update docs/source/install.rst

Co-authored-by: ShinHyung Choi <[email protected]>

* Update docs/source/install.rst

Co-authored-by: ShinHyung Choi <[email protected]>

* Update docs/source/install.rst

Agree. See comments upper.

Co-authored-by: Roman Babenko <[email protected]>

---------

Co-authored-by: Roman Babenko <[email protected]>
Co-authored-by: ShinHyung Choi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants