-
Notifications
You must be signed in to change notification settings - Fork 6
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
23 changed files
with
1,269 additions
and
121 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,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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,36 @@ | ||
# STOP - Read this First! | ||
Reporting a security vulnerability? | ||
Check out the project's [security policy](https://github.com/zeiss/pylibczirw/security/policy). | ||
|
||
# Fill out and Adjust this Template | ||
|
||
## Description | ||
|
||
Summary of the change(s) and which issue(s) is/are fixed | ||
Relevant motivation and context | ||
Dependencies required for this change | ||
|
||
Fixes # (issue) | ||
|
||
### Type of change | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
## How Has This Been Tested? | ||
|
||
Describe the tests that you ran to verify your changes. | ||
Provide instructions to reproduce. | ||
|
||
## Checklist: | ||
|
||
- [ ] I followed the [Contributing Guidelines](https://github.com/ZEISS/pylibczirw/blob/main/CONTRIBUTING.md). | ||
- [ ] Based on [Commit Parsing](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html): In case a new major release will be created (because the body or footer begins with 'BREAKING CHANGE:'), I created a new [Jupyter notebook with a matching version](https://github.com/ZEISS/pylibczirw/tree/main/doc/jupyter_notebooks). | ||
- [ ] Based on [Commit Parsing](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html): In case a new minor/patch release will be created (because commit begins with 'feat'/('fix' or 'perf')), I optionally created a new [Jupyter notebook with a matching version](https://github.com/ZEISS/pylibczirw/tree/main/doc/jupyter_notebooks). | ||
- [ ] I did a self-review. | ||
- [ ] I commented my code, particularly in hard-to-understand areas. | ||
- [ ] In case of API changes, I updated [API.md](https://github.com/ZEISS/pylibczirw/blob/main/API.md). | ||
- [ ] I have added tests that prove my fix is effective or that my feature works. | ||
- [ ] New and existing unit tests pass locally with my changes. |
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 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,39 @@ | ||
# Based on https://docs.codecov.com/docs/common-recipe-list#set-non-blocking-status-checks | ||
coverage: | ||
status: | ||
project: | ||
default: | ||
informational: true | ||
patch: | ||
default: | ||
informational: true | ||
# Based on https://docs.codecov.com/docs/flags#recommended-automatic-flag-management | ||
flag_management: | ||
default_rules: | ||
statuses: | ||
- type: project | ||
informational: true | ||
- type: patch | ||
informational: true | ||
# Based on https://docs.codecov.com/docs/components | ||
# Based on https://github.com/codecov/example-components | ||
# Based on https://about.codecov.io/blog/codecov-components-breaking-down-coverage-by-filters/ | ||
# Based on https://about.codecov.io/blog/granular-test-coverage-analysis-using-components-in-codecov/ | ||
component_management: | ||
default_rules: | ||
statuses: | ||
- type: project | ||
informational: true | ||
- type: patch | ||
informational: true | ||
individual_components: | ||
- component_id: "id_pylibczirw_python" | ||
name: pylibczirw_python | ||
paths: | ||
- "pylibCZIrw/" | ||
- component_id: "id_pylibczirw_c" | ||
name: pylibczirw_c | ||
paths: | ||
- "_pylibCZIrw/" | ||
comment: | ||
layout: "header, diff, flags, components" # show component info in the PR comment |
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: CLA | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
types: | ||
- opened | ||
- reopened | ||
- synchronize | ||
- labeled | ||
- unlabeled | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
# Based on https://stackoverflow.com/questions/71502652/prevent-merging-of-branch-conditionally-based-on-label | ||
fail-for-no-cla: | ||
if: ${{!contains(github.event.pull_request.labels.*.name, 'cla')}} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Fail for missing cla label | ||
run: | | ||
echo "cla label missing. See CONTRIBUTING.md." | ||
exit 1 |
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,49 @@ | ||
# Simple workflow for deploying static content to GitHub Pages | ||
name: Pages | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow one concurrent deployment | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
env: | ||
DOCPATH: pylibCZIrw-documentation.html | ||
|
||
jobs: | ||
# Single deploy job since we're just deploying | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
# From https://github.com/pandoc/pandoc-action-example | ||
- uses: docker://pandoc/core:2.12 | ||
with: | ||
args: >- # allows you to break string into multiple lines | ||
--self-contained | ||
--output=${{ env.DOCPATH }} | ||
API.md | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v2 | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
# Upload entire repository | ||
path: "${{github.workspace}}/${{ env.DOCPATH }}" | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@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,18 @@ | ||
name: REUSE | ||
|
||
on: | ||
push: | ||
branches: ["main"] | ||
pull_request: | ||
branches: ["main"] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
REUSE: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: REUSE Compliance Check | ||
uses: fsfe/reuse-action@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,36 @@ | ||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ | ||
Upstream-Name: pylibCZIrw | ||
Upstream-Contact: Carl Zeiss Microscopy GmbH <github.microscopy@zeiss.com> | ||
Source: https://github.com/ZEISS/pylibczirw | ||
|
||
Files: .github/* | ||
Copyright: 2024 Carl Zeiss Microscopy GmbH | ||
License: CC0-1.0 | ||
|
||
Files: hooks/* | ||
Copyright: 2024 Carl Zeiss Microscopy GmbH | ||
License: CC0-1.0 | ||
|
||
Files: templates/* | ||
Copyright: 2024 Carl Zeiss Microscopy GmbH | ||
License: CC0-1.0 | ||
|
||
Files: _pylibCZIrw/* | ||
Copyright: 2017-2022 Carl Zeiss Microscopy GmbH | ||
License: LGPL-3.0-or-later | ||
|
||
Files: doc/* | ||
Copyright: 2017-2022 Carl Zeiss Microscopy GmbH | ||
License: LGPL-3.0-or-later | ||
|
||
Files: pylibCZIrw/* | ||
Copyright: 2017-2022 Carl Zeiss Microscopy GmbH | ||
License: LGPL-3.0-or-later | ||
|
||
Files: test_data/* | ||
Copyright: 2017-2022 Carl Zeiss Microscopy GmbH | ||
License: LGPL-3.0-or-later | ||
|
||
Files: cla_*.txt CODE_OF_CONDUCT.md CONTRIBUTING.md README.md SECURITY.md API.md CHANGELOG.md INFO.md TROUBLESHOOTING.md CMake* MANIFEST.in NOTICE.txt python-semantic-release.json .gitignore .gitattributes .gitmodules [Doc]* bandit.yaml requirements_*.txt setup.cfg setup.py tox.ini tox_cibuildwheel.ini | ||
Copyright: 2017-2022 Carl Zeiss Microscopy GmbH | ||
License: LGPL-3.0-or-later |
Oops, something went wrong.