-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds a lint workflow and templates for PR and Issues
- Loading branch information
1 parent
1a77256
commit e9b86db
Showing
4 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: '[BUG] ' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
## Describe the Bug | ||
<!-- A clear and concise description of what the bug is --> | ||
|
||
## To Reproduce | ||
|
||
Steps to reproduce the behavior: | ||
|
||
1. Run command '...' | ||
2. Use file '...' | ||
3. See error | ||
|
||
## Expected Behavior | ||
<!-- A clear and concise description of what you expected to happen --> | ||
|
||
## Actual Behavior | ||
<!-- A clear and concise description of what actually happened --> | ||
|
||
## Screenshots/Logs | ||
<!-- If applicable, add screenshots or logs to help explain your problem --> | ||
|
||
## Environment | ||
|
||
- OS: [e.g. macOS 14.2] | ||
- Python Version: [e.g. 3.13] | ||
- pdf2txt Version: [e.g. 0.1.0] | ||
- Tesseract Version: [e.g. 5.3.3] | ||
|
||
## Additional Context | ||
<!-- Add any other context about the problem here --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: '[FEATURE] ' | ||
labels: enhancement | ||
assignees: '' | ||
--- | ||
|
||
## Is your feature request related to a problem? | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
## Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen --> | ||
|
||
## Describe alternatives you've considered | ||
<!-- A clear and concise description of any alternative solutions or features you've considered --> | ||
|
||
## Example Use Case | ||
<!-- Provide an example of how this feature would be used --> | ||
|
||
## Additional Context | ||
<!-- Add any other context, screenshots, or examples about the feature request here --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## Description | ||
<!-- Describe your changes in detail --> | ||
|
||
## Motivation and Context | ||
<!-- Why is this change required? What problem does it solve? --> | ||
|
||
## Type of Change | ||
<!-- Please delete options that are not relevant --> | ||
- [ ] 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 not work as expected) | ||
- [ ] Documentation update | ||
|
||
## How Has This Been Tested? | ||
<!-- Please describe the tests that you ran to verify your changes --> | ||
|
||
## Checklist | ||
|
||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing tests pass locally with my changes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Lint | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.13" | ||
cache: "uv" | ||
|
||
- name: Install uv | ||
run: | | ||
curl -LsSf https://astral.sh/uv/install.sh | sh | ||
uv --version | ||
- name: Install dependencies | ||
run: | | ||
uv pip install --system ruff | ||
- name: Run linting | ||
run: ruff check . |