Skip to content

Commit

Permalink
Prepare repository
Browse files Browse the repository at this point in the history
  • Loading branch information
melissawm committed Oct 13, 2022
0 parents commit 960872f
Show file tree
Hide file tree
Showing 376 changed files with 33,024 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: "\U0001F41B Bug Report"
about: Submit a bug report to help us improve napari
title: ''
labels: bug
assignees: ''

---

## 🐛 Bug

<!-- A clear and concise description of what the bug is. -->

## To Reproduce

Steps to reproduce the behavior:

1.
2.
3.

<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## Environment

- Please copy and paste the information at napari info option in help menubar here:

- Any other relevant information:

## Additional context

<!-- Add any other context about the problem here. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true # default
contact_links:
- name: 🤷💻 napari forum
url: https://forum.image.sc/tag/napari
about: |
Please ask general "how do I ... ?" questions over at image.sc
- name: '💬 napari @ zulip'
url: https://napari.zulipchat.com/
about: Chat with devs
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/design_related.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "\U00002728 Design Related"
about: Capture needs specific to design and user experience research
title: ''
labels: design
assignees: liaprins-czi

---

### Overview of design need
- Is there an existing GitHub issue this design work pertains to?
- If so, provide a link to it
- Also link to any specific comments or threads where the problem to be solved by design is mentioned
- In a sentence or two, describe the problem to be solved for users

### What level of design is needed? (Choose all that apply)
_This section may be updated by the designer / UX researcher working on this issue_

- [ ] **User experience research:** high-level recommendation/exploration of user needs, design heuristics, and / or best practices to inform a design experience
(Use this option when you feel there’s a challenge to be solved, but you’re curious about what the experience should be — may involve research studies to understand challenges/opportunities for design)
- [ ] **information flow / conceptual:** organizing and structuring of information flow and content, including layout on screen or across multiple steps
- [ ] **Visual:** creating mockups, icons, etc
(If choosing this level alone, it means that the content to be mocked up and its organization is already known and specified)

### Is design a blocker?
- [ ] **Yes:** engineering cannot proceed without a design first
- [ ] **No:** engineering can create a first version, and design can come in later to iterate and refine

If selecting **Yes**, how much design input is needed to unblock engineering? For example, is a full, final visual design needed, or just a recommendation of which conceptual direction to go?
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: "\U0001F4DA Documentation"
about: Report an issue with napari documentation
title: ''
labels: documentation
assignees: ''

---

## 📚 Documentation
<!-- A clear and concise description of the documentation that needs to be created/updated -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "\U0001F680 Feature Request"
about: Submit a proposal/request for a new napari feature
title: ''
labels: feature
assignees: ''

---

## 🚀 Feature
<!-- A clear and concise description of the feature proposal -->

## Motivation

<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->

## Pitch

<!-- A clear and concise description of what you want to happen. -->

## Alternatives

<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: "\U0001F9F0 Task"
about: Submit a proposal/request for a new napari feature
title: ''
labels: task
assignees: ''

---

## 🧰 Task
<!-- A clear and concise description of the task -->
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Description
<!-- What does this pull request (PR) do? Why is it necessary? -->
<!-- Tell us about your new feature, improvement, or fix! -->
<!-- If your change includes user interface changes, please add an image, or an animation "An image is worth a thousand words!" -->
<!-- You can use https://www.cockos.com/licecap/ or similar to create animations -->

## Type of change
<!-- Please delete options that are not relevant. -->
- [ ] 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

# References
<!-- What resources, documentation, and guides were used in the creation of this PR? -->
<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->

# How has this been tested?
<!-- Please describe the tests that you ran to verify your changes. -->
- [ ] example: the test suite for my feature covers cases x, y, and z
- [ ] example: all tests pass with my change

## Final checklist:
- [ ] My PR is the minimum possible work for the desired functionality
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] If I included new strings, I have used `trans.` to make them localizable.
For more information see our [translations guide](https://napari.org/docs/dev/guides/translations.html).
12 changes: 12 additions & 0 deletions .github/TEST_FAIL_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "{{ env.TITLE }}"
labels: [bug]
---
The {{ workflow }} workflow failed on {{ date | date("YYYY-MM-DD HH:mm") }} UTC

The most recent failing test was on {{ env.PLATFORM }} py{{ env.PYTHON }} {{ env.BACKEND }}
with commit: {{ sha }}

Full run: https://github.com/{{ payload.repository.full_name }}/actions/runs/{{ env.RUN_ID }}

(This post will be updated if another test fails, as long as this issue remains open.)
26 changes: 26 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# See: .github/workflows/labeler.yml and https://github.com/marketplace/actions/labeler
design:
- 'napari/_qt/qt_resources/**/*'

documentation:
- 'docs/**/*'
- 'docs/*'

preferences:
- 'napari/_qt/**/*/preferences_dialog.py'
- 'napari/settings/**/*.py'

qt:
- 'napari/_qt/**/*.py'
- 'napari/_qt/**/*.py'
- 'napari/qt/**/*.py'
- 'napari/qt/**/*.py'

task:
- '.github/**/*'

tests:
- '**/*/_tests/**/*.py'

vispy:
- 'napari/_vispy'
14 changes: 14 additions & 0 deletions .github/missing_translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: [Automatic issue] Missing `_.trans()`.
labels: "good first issue"
---

It looks like one of our test cron detected missing translations.
You can see the latest output [here](https://github.com/napari/napari/actions/workflows/test_translations.yml).
There are likely new strings to either ignore, or to internationalise.

You can also Update the cron script to update this issue with better information as well.

Note that this issue will be automatically updated if kept open, or a new one will be created when necessary, if no open
issue is found and new `_.trans` call are missing.

15 changes: 15 additions & 0 deletions .github/workflows/auto_author_assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# https://github.com/marketplace/actions/auto-author-assign
name: 'Auto Author Assign'

on:
pull_request_target:
types: [opened, reopened]

permissions:
pull-requests: write

jobs:
assign-author:
runs-on: ubuntu-latest
steps:
- uses: toshimaru/[email protected]
67 changes: 67 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Build and Deploy Docs

on:
push:
branches:
- main
tags:
- 'v*'
workflow_dispatch:

# Only allow one docs build at a time so that overlapping stale builds will get
# cancelled automatically.
concurrency:
group: deploy_docs
cancel-in-progress: true

jobs:
build-and-deploy:
name: Build & Deploy
runs-on: ubuntu-latest
steps:
- name: Clone docs repo
uses: actions/checkout@main
with:
path: docs # place in a named directory

- name: Clone main repo
uses: actions/checkout@main
with:
path: napari
ref: two-repo
repository: melissawm/napari

- uses: actions/setup-python@v2
with:
python-version: 3.9

- uses: tlambert03/setup-qt-libs@v1

- name: Install Dependencies
run: |
python -m pip install --upgrade pip
python -m pip install "napari/[all]"
python -m pip install -r docs/requirements.txt
- name: Testing
run: |
python -c 'import napari; print(napari.__version__)'
python -c 'import napari.layers; print(napari.layers.__doc__)'
- name: Build Docs
uses: GabrielBB/xvfb-action@v1
env:
GOOGLE_CALENDAR_ID: ${{ secrets.GOOGLE_CALENDAR_ID }}
GOOGLE_CALENDAR_API_KEY: ${{ secrets.GOOGLE_CALENDAR_API_KEY }}
with:
run: make -C docs/docs docs

- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v3
with:
#deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
#external_repository: melissawm/napari.github.io
publish_dir: docs/docs/_build
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
#cname: napari.org
12 changes: 12 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# https://github.com/marketplace/actions/labeler
name: "Pull Request Labeler"
on:
- pull_request_target

jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@main
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
Loading

0 comments on commit 960872f

Please sign in to comment.