-
Notifications
You must be signed in to change notification settings - Fork 1
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
Showing
25 changed files
with
1,322 additions
and
209 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
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,13 @@ | ||
# SPDX-FileCopyrightText: 2021 Adafruit Industries | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
Thank you for contributing! Before you submit a pull request, please read the following. | ||
|
||
Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html | ||
|
||
If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs | ||
|
||
Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code | ||
|
||
Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. |
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,14 @@ | ||
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
name: Build CI | ||
|
||
on: [pull_request, push] | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Run Build CI workflow | ||
uses: adafruit/workflows-circuitpython-libs/build@main |
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,19 @@ | ||
# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
name: Failure help text | ||
|
||
on: | ||
workflow_run: | ||
workflows: ["Build CI"] | ||
types: | ||
- completed | ||
|
||
jobs: | ||
post-help: | ||
runs-on: ubuntu-latest | ||
if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} | ||
steps: | ||
- name: Post comment to help | ||
uses: adafruit/circuitpython-action-library-ci-failed@v1 |
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,20 @@ | ||
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
name: GitHub Release Actions | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
upload-release-assets: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Run GitHub Release CI workflow | ||
uses: adafruit/workflows-circuitpython-libs/release-gh@main | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
upload-url: ${{ github.event.release.upload_url }} | ||
package-prefix: toml |
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 |
---|---|---|
@@ -1,4 +1,50 @@ | ||
# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries | ||
# | ||
# SPDX-License-Identifier: MIT | ||
|
||
# Do not include files and directories created by your personal work environment, such as the IDE | ||
# you use, except for those already listed here. Pull requests including changes to this file will | ||
# not be accepted. | ||
|
||
# This .gitignore file contains rules for files generated by working with CircuitPython libraries, | ||
# including building Sphinx, testing with pip, and creating a virual environment, as well as the | ||
# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. | ||
|
||
# If you find that there are files being generated on your machine that should not be included in | ||
# your git commit, you should create a .gitignore_global file on your computer to include the | ||
# files created by your personal setup. To do so, follow the two steps below. | ||
|
||
# First, create a file called .gitignore_global somewhere convenient for you, and add rules for | ||
# the files you want to exclude from git commits. | ||
|
||
# Second, configure Git to use the exclude file for all Git repositories by running the | ||
# following via commandline, replacing "path/to/your/" with the actual path to your newly created | ||
# .gitignore_global file: | ||
# git config --global core.excludesfile path/to/your/.gitignore_global | ||
|
||
toml-test.out | ||
|
||
# CircuitPython-specific files | ||
*.mpy | ||
|
||
# Python-specific files | ||
__pycache__ | ||
_build | ||
*.pyc | ||
toml-test.out | ||
|
||
# Sphinx build-specific files | ||
_build | ||
|
||
# This file results from running `pip -e install .` in a local repository | ||
*.egg-info | ||
|
||
# Virtual environment-specific files | ||
.env | ||
.venv | ||
|
||
# MacOS-specific files | ||
*.DS_Store | ||
|
||
# IDE-specific files | ||
.idea | ||
.vscode | ||
*~ |
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,42 @@ | ||
# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò | ||
# | ||
# SPDX-License-Identifier: Unlicense | ||
|
||
repos: | ||
- repo: https://github.com/python/black | ||
rev: 23.3.0 | ||
hooks: | ||
- id: black | ||
- repo: https://github.com/fsfe/reuse-tool | ||
rev: v1.1.2 | ||
hooks: | ||
- id: reuse | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.4.0 | ||
hooks: | ||
- id: check-yaml | ||
- id: end-of-file-fixer | ||
- id: trailing-whitespace | ||
- repo: https://github.com/pycqa/pylint | ||
rev: v2.17.4 | ||
hooks: | ||
- id: pylint | ||
name: pylint (library code) | ||
types: [python] | ||
args: | ||
- --disable=consider-using-f-string | ||
exclude: "^(docs/|examples/|tests/|setup.py$)" | ||
- id: pylint | ||
name: pylint (example code) | ||
description: Run pylint rules on "examples/*.py" files | ||
types: [python] | ||
files: "^examples/" | ||
args: | ||
- --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code | ||
- id: pylint | ||
name: pylint (test code) | ||
description: Run pylint rules on "tests/*.py" files | ||
types: [python] | ||
files: "^tests/" | ||
args: | ||
- --disable=missing-docstring,consider-using-f-string,duplicate-code |
Oops, something went wrong.