Skip to content

Commit

Permalink
Require version in bug template and add section for logs
Browse files Browse the repository at this point in the history
These additions should help myself or future maintainers debug issues
that people file more easily. Also, the version is now logged to
provide a bit more information
  • Loading branch information
jdholtz committed Aug 5, 2023
1 parent 71de035 commit d995f98
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
13 changes: 11 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ body:
attributes:
value: |
Thank you for taking the time to report a bug!
- type: textarea
attributes:
label: Version
description: Output of `python southwest.py --version`
validations:
required: true
- type: textarea
attributes:
label: Description
Expand All @@ -27,8 +33,11 @@ body:
description: A clear and concise description of what you expected to happen.
- type: textarea
attributes:
label: Version
description: Output of `python southwest.py --version`
label: Relevant logs and program output
description: |
Please paste relevant output or logs here. Additionally, the log file can be attached to this issue (found at `logs/auto-southwest-check-in.log`)
placeholder: This will be automatically formatted into code, so no need for backticks.
render: sh
- type: textarea
attributes:
label: Additional context
Expand Down
1 change: 1 addition & 0 deletions lib/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ def set_up_check_in(arguments: List[str]) -> None:
Initialize reservation and account monitoring based on the configuration
and arguments passed in
"""
logger.debug(f"Auto-Southwest Check-In {__version__}")
logger.debug("Called with %d arguments", len(arguments))

# Imported here to avoid needing dependencies to retrieve the script's
Expand Down

0 comments on commit d995f98

Please sign in to comment.