Skip to content

Commit

Permalink
release v1.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ruslansenatorov committed Oct 26, 2024
1 parent 203ba6b commit 99f14a7
Show file tree
Hide file tree
Showing 25 changed files with 970 additions and 4 deletions.
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug report
description: Create a bug report to help us address errors in the repository
labels: [bug]
body:
- type: markdown
attributes:
value: >
<p>Attention! </p>
<b>We insert an error message from the terminal into the name of the issues!</b>
- type: markdown
attributes:
value: >
Before requesting please search [existing issues](https://t.me/c/1937296927/3602/25534).
- type: input
attributes:
label: "Hash commit / link"
description: >
If possible, provide a hash of your commit or just paste the link to it here
placeholder: "a0b0f414ae134aa1772d33bb930e5a960f9979e8"
validations:
required: false

- type: input
attributes:
label: "Video"
description: >
insert a link to a YouTube video where you demonstrate the problem and show how to reproduce it
placeholder: "link to the video"
validations:
required: false

- type: textarea
attributes:
label: "Attach a screenshot and write what did you do to fix the problem?"
description: "Attach a full screenshot of your screen, which will show the entire desktop and your error"
validations:
required: true

- type: textarea
attributes:
label: "Error from the terminal / Code"
description: >
write the code or copy the error from the terminal and paste it here, also provide log file if possible
placeholder: |
scripts/build_directory_md.py:22: error: Function is missing a type annotation
[no-untyped-def]
def md_prefix(i):
^
scripts/build_directory_md.py:32: error: Call to untyped function "md_prefix"
in typed context [no-untyped-call]
print(f"{md_prefix(i)} {new_part.replace('_', ' ').title()...
^~~~~~~~~~~~~
scripts/build_directory_md.py:46: error: Call to untyped function "md_prefix"
in typed context [no-untyped-call]
print(f"{md_prefix(indent)} [{filename}]({url})")
...
validations:
required: true

- type: textarea
attributes:
label: "Expected behavior"
description: "Describe the behavior you expect. May include images or videos."
validations:
required: true
- type: textarea
attributes:
label: "Actual behavior"
description: >
Actual behavior with a description of how to reproduce the problem
placeholder: |
## Steps to Reproduce the Problem
1.
2.
3.
...
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Telegram community
url: https://t.me/RuslanSenatorov
about: Have any questions or need any help? Please contact us via Telegram
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Feature request
description: Suggest features, propose improvements, discuss new ideas.
labels: [enhancement]
body:
- type: markdown
attributes:
value: >
Before requesting please search [existing issues](https://t.me/c/1937296927/3602/25534).
- type: textarea
attributes:
label: "Feature description"
description: >
This could include new topics or improving any existing implementations.
validations:
required: true
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Other
description: Use this for any other issues. PLEASE do not create blank issues
labels: ["awaiting triage"]
body:
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true

- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Keep GitHub Actions up to date with Dependabot...
# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### Describe your change:

ПИШЕМ ЗДЕСЬ ЧТО СДЕЛАЛИ, И ВМЕСТО 'ISSUE-NUMBER' вставляем номер

Fixes #ISSUE-NUMBER

* [ ] Add an algorithm?
* [ ] Fix a bug or typo in an existing algorithm?
* [ ] Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
* [ ] Documentation change?

### Checklist:
* [ ] I have read [CONTRIBUTING.md](https://github.com/SENATOROVAI/pre-commit/blob/main/CONTRIBUTING.md).
* [ ] This pull request is all my own work -- I have not plagiarized.
* [ ] I know that pull requests will not be merged if they fail the automated tests.
* [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
* [ ] All new Python files are placed inside an existing directory.
* [ ] All filenames are in all lowercase characters with no spaces or dashes.
* [ ] All functions and variable names follow Python naming conventions.
* [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html).
* [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing.
* [ ] All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
* [ ] If this pull request resolves one or more open issues then the description above includes the issue number(s) with a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue): "Fixes #ISSUE-NUMBER".
63 changes: 63 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Configuration for probot-stale - https://github.com/probot/stale

# Number of days of inactivity before an Issue or Pull Request becomes stale
daysUntilStale: 30

# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
daysUntilClose: 7

# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
onlyLabels: []

# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
exemptLabels:
- "Status: on hold"

# Set to true to ignore issues in a project (defaults to false)
exemptProjects: false

# Set to true to ignore issues in a milestone (defaults to false)
exemptMilestones: false

# Set to true to ignore issues with an assignee (defaults to false)
exemptAssignees: false

# Label to use when marking as stale
staleLabel: stale

# Limit the number of actions per hour, from 1-30. Default is 30
limitPerRun: 5

# Comment to post when removing the stale label.
# unmarkComment: >
# Your comment here.

# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
pulls:
# Comment to post when marking as stale. Set to `false` to disable
markComment: >
This pull request has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale Pull Request.
closeComment: >
Please reopen this pull request once you commit the changes requested
or make improvements on the code. If this is not the case and you need
some help, feel free to seek help from our [Gitter](https://gitter.im/TheAlgorithms/community)
or ping one of the reviewers. Thank you for your contributions!
issues:
# Comment to post when marking as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale Issue.
closeComment: >
Please reopen this issue once you add more information and updates here.
If this is not the case and you need some help, feel free to seek help
from our [Gitter](https://gitter.im/TheAlgorithms/community) or ping one of the
reviewers. Thank you for your contributions!
39 changes: 39 additions & 0 deletions .github/workflows/black.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "SENATOROV"

permissions:
contents: write # Grant write access to the repository contents
on:
push:
branches:
- "**"
pull_request:
branches:
- "**"
schedule:
- cron: "0 0 * * *" # Run every day
workflow_dispatch:
create:
delete:
release:
issues:
pull_request_review:
pull_request_review_comment:

jobs:
black:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install black "black[jupyter]" nbqa
- name: Black
run: |
black --check --diff --line-length=79 $(git ls-files '*.py' '*.ipynb')
nbqa black --check --diff --line-length=79 $(git ls-files '*.py' '*.ipynb')
38 changes: 38 additions & 0 deletions .github/workflows/blacken-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "SENATOROV"

permissions:
contents: write # Grant write access to the repository contents
on:
push:
branches:
- "**"
pull_request:
branches:
- "**"
schedule:
- cron: "0 0 * * *" # Run every day
workflow_dispatch:
create:
delete:
release:
issues:
pull_request_review:
pull_request_review_comment:

jobs:
blacken-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
allow-prereleases: true
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install blacken-docs nbqa
- name: Blacken-docs
run: |
nbqa blacken-docs --nbqa-md --nbqa-diff $(git ls-files '*.py' '*.ipynb')
49 changes: 49 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: "SENATOROV"

permissions:
contents: write # Grant write access to the repository contents

on:
push:
branches:
- "**"
pull_request:
branches:
- "**"
schedule:
- cron: "0 0 * * *" # Run every day
workflow_dispatch:
create:
delete:
release:
issues:
pull_request_review:
pull_request_review_comment:

jobs:
codespell:
runs-on: ubuntu-latest
steps:
# Шаг для клонирования репозитория
- uses: actions/checkout@v4

# Установка Python
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x" # Укажите версию Python, либо используйте матрицу версий

# Установка зависимостей
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install codespell
# Запуск codespell с параметрами
- name: Run codespell
run: |
codespell \
--ignore-regex='^\s*"image\/(jpeg|png|gif|bmp|tiff)":\s.*' \
--ignore-regex="[A-Za-z0-9+/]{100,}" \
--skip="*.js,*.html,*.css,*.svg,*.json,*.png,*.jpg,*.yml,*.yaml" \
$(git ls-files '*.py' '*.ipynb')
28 changes: 28 additions & 0 deletions .github/workflows/directory_writer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "SENATOROV"
permissions:
contents: write
on: [push]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Set script executable permission
run: chmod +x scripts/build_directory_md.py
- name: Write DIRECTORY.md and README.md
run: |
scripts/build_directory_md.py 2>&1 | tee DIRECTORY.md
scripts/build_directory_md.py 2>&1 | tee README.md
git config --global user.name "$GITHUB_ACTOR"
git config --global user.email "[email protected]"
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
- name: Commit and push changes
run: |
git add DIRECTORY.md README.md
git commit -m "SENATOROV updating DIRECTORY.md and README.md" || echo "No changes to commit"
git push --force
Loading

0 comments on commit 99f14a7

Please sign in to comment.