From a4cb1a1cd9e39b2340493fa3f4b90f0e46b106d3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 1 May 2024 06:18:54 +0000 Subject: [PATCH 1/2] Renovate: paddyroddy/.github --- .github/workflows/deploy.yaml | 2 +- .github/workflows/documentation.yaml | 2 +- .github/workflows/licence.yaml | 2 +- .github/workflows/linting.yaml | 2 +- .github/workflows/test.yaml | 2 +- .pre-commit-config.yaml | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 9a4b433..cb7a65c 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: # yamllint disable-line rule:line-length - - uses: paddyroddy/.github/actions/python/deployment@c3bb562d91f4004231cdd8497106a209a7531f40 # v0 + - uses: paddyroddy/.github/actions/python/deployment@bb1ef2b53f8ed8feef3238ab84ad31aaaa6e947d # v0 with: pyproject-toml: ./pyproject.toml python-version: "3.12" diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 34ecc0c..e681635 100644 --- a/.github/workflows/documentation.yaml +++ b/.github/workflows/documentation.yaml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: # yamllint disable-line rule:line-length - - uses: paddyroddy/.github/actions/python/pdoc@c3bb562d91f4004231cdd8497106a209a7531f40 # v0 + - uses: paddyroddy/.github/actions/python/pdoc@bb1ef2b53f8ed8feef3238ab84ad31aaaa6e947d # v0 with: docs-dependency-section: .[docs] gh-pages-publish-directory: ./html/example diff --git a/.github/workflows/licence.yaml b/.github/workflows/licence.yaml index 933b800..18486ad 100644 --- a/.github/workflows/licence.yaml +++ b/.github/workflows/licence.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: # yamllint disable-line rule:line-length - - uses: paddyroddy/.github/actions/licence@c3bb562d91f4004231cdd8497106a209a7531f40 # v0 + - uses: paddyroddy/.github/actions/licence@bb1ef2b53f8ed8feef3238ab84ad31aaaa6e947d # v0 with: github-token: ${{ secrets.GITHUB_TOKEN }} licence-file: ./LICENCE.txt diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml index 05dda1b..5ea40ad 100644 --- a/.github/workflows/linting.yaml +++ b/.github/workflows/linting.yaml @@ -13,6 +13,6 @@ jobs: runs-on: ubuntu-latest steps: # yamllint disable-line rule:line-length - - uses: paddyroddy/.github/actions/linting@c3bb562d91f4004231cdd8497106a209a7531f40 # v0 + - uses: paddyroddy/.github/actions/linting@bb1ef2b53f8ed8feef3238ab84ad31aaaa6e947d # v0 with: pre-commit-config: ./.pre-commit-config.yaml diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6d7de9a..c98c892 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -26,7 +26,7 @@ jobs: - "3.12" steps: # yamllint disable-line rule:line-length - - uses: paddyroddy/.github/actions/python/tox@c3bb562d91f4004231cdd8497106a209a7531f40 # v0 + - uses: paddyroddy/.github/actions/python/tox@bb1ef2b53f8ed8feef3238ab84ad31aaaa6e947d # v0 with: cache-path: |- .tox diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d79b322..99bf16b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,7 @@ --- repos: - repo: https://github.com/paddyroddy/.github - rev: v0.148.0 + rev: v0.164.0 hooks: - id: general-hooks - id: python-hooks From 4946eee08a6a9e5d7f8635a10f47750065a8137b Mon Sep 17 00:00:00 2001 From: "Patrick J. Roddy" Date: Wed, 1 May 2024 10:07:25 +0100 Subject: [PATCH 2/2] Fix linting --- .github/ISSUE_TEMPLATE/bug_report.yaml | 4 +- .github/ISSUE_TEMPLATE/documentation.yaml | 4 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 4 +- CODE_OF_CONDUCT.md | 36 ++++++++--------- CONTRIBUTING.md | 45 +++++++++++---------- 5 files changed, 48 insertions(+), 45 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index ec1f5b7..89111ca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -40,8 +40,8 @@ body: attributes: label: Actual Behaviour description: >- - Be a specific and detailed as you can. - Paste any output or stack traces of errors you receive. + Be a specific and detailed as you can. Paste any output or stack traces + of errors you receive. validations: required: true - id: version diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index 3f77980..52ff8fc 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -25,5 +25,5 @@ body: attributes: label: How to Improve This Section description: >- - Do you have any specific suggestions we - could take to improve the documentation? + Do you have any specific suggestions we could take to improve the + documentation? diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 425b682..b54f5d8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -26,8 +26,8 @@ body: attributes: label: Describe Alternatives You've Considered description: >- - A clear and concise description of any alternative - solutions or features you've considered. + A clear and concise description of any alternative solutions or features + you've considered. - id: additional type: textarea attributes: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 15a16c3..75153f3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. +nationality, personal appearance, race, religion, or sexual identity and +orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. @@ -22,17 +22,17 @@ community include: - Giving and gracefully accepting constructive feedback - Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -- Focusing on what is best not just for us as individuals, but for the - overall community +- Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -- The use of sexualized language or imagery, and sexual attention or - advances of any kind +- The use of sexualized language or imagery, and sexual attention or advances of + any kind - Trolling, insulting or derogatory comments, and personal or political attacks - Public or private harassment -- Publishing others' private information, such as a physical or email - address, without their explicit permission +- Publishing others' private information, such as a physical or email address, + without their explicit permission - Other conduct which could reasonably be considered inappropriate in a professional setting @@ -60,8 +60,8 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -. -All complaints will be reviewed and investigated promptly and fairly. +. All complaints will be reviewed and investigated +promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. @@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested. ### 2. Warning -**Community Impact**: A violation through a single incident or series -of actions. +**Community Impact**: A violation through a single incident or series of +actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. +like social media. Violating these terms may lead to a temporary or permanent +ban. ### 3. Temporary Ban @@ -109,8 +109,8 @@ Violating these terms may lead to a permanent ban. standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -**Consequence**: A permanent ban from any sort of public interaction within -the community. +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution @@ -118,8 +118,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at . -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d2d90c..5698fb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,7 +67,8 @@ steps in advance to help us fix any potential bug as fast as possible. - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://paddyroddy.github.io/python-template). If you are - looking for support, you might want to check [this section](#i-have-a-question)). + looking for support, you might want to check + [this section](#i-have-a-question)). - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the @@ -87,19 +88,20 @@ steps in advance to help us fix any potential bug as fast as possible. > You must never report security related issues, vulnerabilities or bugs > including sensitive information to the issue tracker, or elsewhere in public. -> Instead, sensitive bugs must be sent by email to . +> Instead, sensitive bugs must be sent by email to +> . We use GitHub issues to track bugs and errors. If you run into an issue with the project: - Open an [Issue](https://github.com/paddyroddy/python-template/issues/new). - (Since we can't be sure at this point whether it is a bug or not, we ask you not - to talk about a bug yet and not to label the issue.) + (Since we can't be sure at this point whether it is a bug or not, we ask you + not to talk about a bug yet and not to label the issue.) - Explain the behaviour you would expect and the actual behaviour. - Please provide as much context as possible and describe the _reproduction_ _steps_ that someone else can follow to recreate the issue on their own. This - usually includes your code. For good bug reports you should isolate the problem - and create a reduced test case. + usually includes your code. For good bug reports you should isolate the + problem and create a reduced test case. - Provide the information you collected in the previous section. Once it's filed: @@ -107,18 +109,18 @@ Once it's filed: - The project team will label the issue accordingly. - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the - team will ask you for those steps and mark the issue as `needs-repro`. Bugs with - the `needs-repro` tag will not be addressed until they are reproduced. + team will ask you for those steps and mark the issue as `needs-repro`. Bugs + with the `needs-repro` tag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked `needs-fix`, as - well as possibly other tags (such as `critical`), and the issue will be left to - be implemented by someone. + well as possibly other tags (such as `critical`), and the issue will be left + to be implemented by someone. ### Suggesting Enhancements -This section guides you through submitting an enhancement suggestion for `Example`, -**including completely new features and minor improvements to existing** -**functionality**. Following these guidelines will help maintainers and the -community to understand your suggestion and find related suggestions. +This section guides you through submitting an enhancement suggestion for +`Example`, **including completely new features and minor improvements to +existing** **functionality**. Following these guidelines will help maintainers +and the community to understand your suggestion and find related suggestions. #### Before Submitting an Enhancement @@ -126,9 +128,9 @@ community to understand your suggestion and find related suggestions. - Read the [documentation](https://paddyroddy.github.io/python-template) carefully and find out if the functionality is already covered, maybe by an individual configuration. -- Perform a [search](https://github.com/paddyroddy/python-template/issues) to see - if the enhancement has already been suggested. If it has, add a comment to the - existing issue instead of opening a new one. +- Perform a [search](https://github.com/paddyroddy/python-template/issues) to + see if the enhancement has already been suggested. If it has, add a comment to + the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful @@ -140,12 +142,13 @@ community to understand your suggestion and find related suggestions. Enhancement suggestions are tracked as [GitHub issues](https://github.com/paddyroddy/python-template/issues). -- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Use a **clear and descriptive title** for the issue to identify the + suggestion. - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. -- **Describe the current behaviour** and **explain which behaviour you expected** - **to see instead** and why. At this point you can also tell which alternatives - do not work for you. +- **Describe the current behaviour** and **explain which behaviour you + expected** **to see instead** and why. At this point you can also tell which + alternatives do not work for you. - **Explain why this enhancement would be useful** to most `Example` users. You may also want to point out the other projects that solved it better and which could serve as inspiration.