Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .devcontainer/.dockerignore

This file was deleted.

69 changes: 0 additions & 69 deletions .devcontainer/devcontainer.json

This file was deleted.

63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
name: Bug Report
description: Create a Report to Help us Improve
labels:
- bug
body:
- id: describe
type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true
- id: reproduce
type: textarea
attributes:
label: To Reproduce
description: >-
A minimal working example of code to reproduce the unexpected behaviour,
this will render as `Python` code so no need for backticks.
value: |-
import soundscapy

...
render: Python
validations:
required: true
- id: expected
type: textarea
attributes:
label: Expected Behaviour
description: >-
A clear and concise description of what you expected to happen.
validations:
required: true
- id: actual
type: textarea
attributes:
label: Actual Behaviour
description: >-
Be a specific and detailed as you can. Paste any output or stack traces
of errors you receive.
validations:
required: true
- id: version
type: input
attributes:
label: Version In Use
description: |-
Can be found by
```sh
python -c "import soundscapy; print(soundscapy.__version__)"
```
validations:
required: true
- id: additional
type: textarea
attributes:
label: Additional Context
value: |-
- Python version:
- Operating system:
render: Markdown
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: false
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Documentation
description: How Can We Improve the Documentation
labels:
- documentation
body:
- id: section
type: textarea
attributes:
label: Which Section of the Documentation Needs Improving?
description: Please provide a link (if it is a specific page).
validations:
required: true
- id: problem
type: textarea
attributes:
label: What Can be Improved About This Section
description: Is it incomplete, incorrect or difficult to understand?
validations:
required: true
- id: suggestions
type: textarea
attributes:
label: How to Improve This Section
description: >-
Do you have any specific suggestions we could take to improve the
documentation?
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature Request
description: Suggest a Way to Improve This Project
labels:
- enhancement
body:
- id: problem
type: textarea
attributes:
label: Is Your Feature Request Related to a Problem? Please Describe
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
validations:
required: true
- id: solution
type: textarea
attributes:
label: Describe the Solution You'd Like
description: A clear and concise description of what you want to happen.
validations:
required: true
- id: alternatives
type: textarea
attributes:
label: Describe Alternatives You've Considered
description: >-
A clear and concise description of any alternative solutions or features
you've considered.
- id: additional
type: textarea
attributes:
label: Additional Context
description: >-
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Question
description: General Questions About Using Soundscapy
labels:
- question
body:
- id: topic
type: dropdown
attributes:
label: What is the Topic of Your Question
description: Please indicate the topic in the title of your question.
options:
- Documentation
- Installation
- Usage
- Other
validations:
required: true
- id: question
type: textarea
attributes:
label: Add Your Question Below
validations:
required: true
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Documentation

on:
workflow_call:
outputs:
docs-pass:
description: "Indicates if documentation build passed"
value: ${{ github.event.inputs.docs-pass }}
push:
branches:
- main
pull_request:

jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Cache tox
uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
with:
path: .tox
key: tox-${{ hashFiles('pyproject.toml') }}

- name: Set up Python
uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5
with:
python-version: "3.x"
cache: "pip"
cache-dependency-path: "pyproject.toml"

- name: Install tox
run: python -m pip install tox
- name: Build HTML documentation with tox
run: tox -e docs
33 changes: 33 additions & 0 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Linting

on:
push:
branches:
- main
pull_request:

jobs:
linting:
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Cache pre-commit
uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
with:
path: ~/.cache/pre-commit
key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}

- name: Set up python
uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5
with:
python-version: "3.x"
cache: pip
cache-dependency-path: pyproject.toml

- name: Install dependencies
run: python -m pip install pre-commit

- name: Run pre-commit
run: pre-commit run --all-files --color always --verbose
Loading