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

Add help command to Makefile #14

Merged
merged 1 commit into from
Dec 12, 2023
Merged

Conversation

jonavellecuerdo
Copy link
Contributor

@jonavellecuerdo jonavellecuerdo commented Dec 12, 2023

Purpose and background context

It was decided that we include a 'help' command to the Makefile to give an overview of the available Makefile commands.

How can a reviewer manually see the effects of these changes?

Run make help. You should see the following:

(python-cli-template) jcuerdo@X4GPY162G1 python-cli-template % make help
Usage:  make <target>

Targets:
  help            preview Makefile commands
  install         install Python dependencies
  update          update Python dependencies
  test            run tests and print a coverage report
  coveralls       write coverage data to an LCOV report
  lint            run linters
  black           run 'black' linter and print a preview of suggested changes
  mypy            run 'mypy' linter
  ruff            run 'ruff' linter and print a preview of errors
  safety          check for security vulnerabilities and verify Pipfile.lock is up-to-date
  lint-apply      apply changes with 'black' and resolve 'fixable errors' with 'ruff'
  black-apply     apply changes with 'black'
  ruff-apply      resolve 'fixable errors' with 'ruff'

Includes new or updated dependencies?

NO

Changes expectations for external applications?

NO

What are the relevant tickets?

Developer

  • All new ENV is documented in README
  • All new ENV has been added to staging and production environments
  • All related Jira tickets are linked in commit message(s)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer(s)

  • The commit message is clear and follows our guidelines (not just this PR message)
  • There are appropriate tests covering any new functionality
  • The provided documentation is sufficient for understanding any new functionality introduced
  • Any manual tests have been performed and verified
  • New dependencies are appropriate or there were no changes

Why these changes are being introduced:
* Provide simple documentation for Makefile commands

How this addresses that need:
* Add template for documenting commands using comments

Side effects of this change:
* I adjusted the comment slightly to pull comments marked by a single hash (#)
as opposed to two. To document a Makefile command, the description must be a comment
that appears next to the command declaration, denoted by a single hash.

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-894
Copy link
Contributor

@ghukill ghukill left a comment

Choose a reason for hiding this comment

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

Left a comment about double ampersands, but that's either true / not true, and approved either way! Looks good, thanks for this.

Makefile Show resolved Hide resolved
@jonavellecuerdo jonavellecuerdo merged commit 022327e into main Dec 12, 2023
2 checks passed
@jonavellecuerdo jonavellecuerdo deleted the add-help-cmd-to-makefile branch December 12, 2023 18:39
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