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

doc: add installation instruction #982

Closed
wants to merge 1 commit into from
Closed

Conversation

bagustris
Copy link

Description

Add an instruction to install using pip.

Motivation and Context

No installation instructions have been given on the installation page. In the Github readme page, I follow Installation link, but only Packaging status is given.

How Has This Been Tested?

pip install git-cliff

Types of Changes

  • 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)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

add instruction to install using pip
@bagustris bagustris requested a review from orhun as a code owner December 11, 2024 09:47
Copy link

welcome bot commented Dec 11, 2024

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

@bagustris bagustris changed the title doc: add installation instrunction doc: add installation instruction Dec 11, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.85%. Comparing base (e85888f) to head (2278fb7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #982   +/-   ##
=======================================
  Coverage   42.85%   42.85%           
=======================================
  Files          21       21           
  Lines        1734     1734           
=======================================
  Hits          743      743           
  Misses        991      991           
Flag Coverage Δ
unit-tests 42.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@orhun
Copy link
Owner

orhun commented Dec 11, 2024

Hello! The instructions are already available here: https://git-cliff.org/docs/installation/pypi

But maybe we can rename PyPI to pip for making it more clear.

@orhun orhun closed this Dec 11, 2024
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.

3 participants