-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
luca-medeiros
committed
Sep 23, 2024
1 parent
895e832
commit 0a12766
Showing
14 changed files
with
148 additions
and
902 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 @@ | ||
.venv |
This file was deleted.
Oops, something went wrong.
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,54 @@ | ||
name: 🐛 Bugs | ||
description: Report bugs | ||
labels: ["bug"] | ||
title: "Please read & provide the following" | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Instructions To Reproduce the 🐛 Bug: | ||
1. Background explanation | ||
- type: textarea | ||
attributes: | ||
label: Full runnable code or full changes you made: | ||
description: Please provide the code or changes that led to the bug. | ||
placeholder: | | ||
``` | ||
``` | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: What exact command you ran: | ||
description: Describe the exact command you ran that triggered the bug. | ||
validations: | ||
required: true | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
1. Please simplify the steps as much as possible so they do not require additional resources to | ||
run, such as a private dataset. | ||
## Expected behavior: | ||
If there are no obvious errors in "full logs" provided above, | ||
please tell us the expected behavior. | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Describe the expected behavior if the bug had not occurred. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Environment | ||
description: Indicate your environment details. | ||
options: | ||
- label: "I'm using the latest version!" | ||
- label: "It's not a user-side mistake!" |
This file was deleted.
Oops, something went wrong.
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,26 @@ | ||
name: 📚 Documentation Issue | ||
description: Report a problem about existing documentation or comments. | ||
labels: ["documentation"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## 📚 Documentation Issue | ||
This issue category is for problems about existing documentation, not for asking how-to questions. | ||
- type: input | ||
attributes: | ||
label: Provide a link to existing documentation/comment | ||
description: Paste the URL or path to the documentation or comment that has an issue. | ||
placeholder: "https://example.com/docs/section" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: How should the above documentation/comment improve? | ||
description: Describe the changes or improvements that should be made to the documentation or comment. | ||
placeholder: "Please describe the suggested improvements here." | ||
validations: | ||
required: true |
This file was deleted.
Oops, something went wrong.
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,30 @@ | ||
name: 🚀 Feature Request | ||
description: Suggest an improvement or new feature | ||
labels: ["enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## 🚀 Feature | ||
A clear and concise description of the feature proposal. | ||
- type: textarea | ||
attributes: | ||
label: Motivation & Examples | ||
description: | | ||
Tell us why the feature is useful. | ||
Describe what the feature would look like if it is implemented. Best demonstrated using **code examples** in addition to words. | ||
placeholder: | | ||
<put sample here> | ||
validations: | ||
required: true | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
## Note | ||
We only consider adding new features if they are relevant to this library. | ||
Consider if this new feature deserves to be here or should be a new library. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,29 @@ | ||
name: pre-commit | ||
on: [push, pull_request] | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout branch | ||
uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Get changed files | ||
id: changed-files | ||
uses: tj-actions/changed-files@v35 | ||
with: | ||
files: '**/*.py' | ||
|
||
- name: Set up Python [3.11] | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: "3.11" | ||
|
||
- name: Install pre-commit | ||
run: pip install pre-commit | ||
|
||
- name: Run pre-commit on changed files | ||
run: | | ||
pre-commit run --files ${{ steps.changed-files.outputs.all_changed_files }} |
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.