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

Suggestion for updating the installation instructions #33

Open
gradytrain opened this issue Jan 31, 2025 · 0 comments
Open

Suggestion for updating the installation instructions #33

gradytrain opened this issue Jan 31, 2025 · 0 comments

Comments

@gradytrain
Copy link

Hi guys,

Hope you guys at TomTom are all doing well. I am starting to implement a conventional commits gate at my company that uses GitLab CI and eventually got to where I can do a fully integration. The problem I was having is following the posted instructions for installation led to mixed results even locally.

  • When I used pip install it did not put the main:cli entrypoint binary into the install path, it did put the commisery-verify-msg and another similar binary though but I had to manually integrate them into my path.

  • The only way I could get the main:cli i.e. the cm command to run was to do a pip install . on the cloned repo

I am not sure if this is a "Your mileage may vary" situation or not but I think if I could lend a suggestion, that you guys update your installation procedure to confirm the cm entrypoint is hit OR either update the documentation to include instructions to get the cm entrypoint to work or add the additional installation option of pip install . on the cloned repo.

I didn't want to make a cold PR but I think future users could benefit from the additional clarity or QoL update.

@gradytrain gradytrain changed the title Suggestion for updating the installation instructions documentation Suggestion for updating the installation instructions Jan 31, 2025
@gradytrain gradytrain changed the title documentation Suggestion for updating the installation instructions Suggestion for updating the installation instructions Jan 31, 2025
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

No branches or pull requests

1 participant