Skip to content

Commit

Permalink
Merge branch 'develop' into dev/jk
Browse files Browse the repository at this point in the history
  • Loading branch information
AarynnCarter authored Jul 30, 2024
2 parents 0d0e04d + 14de10c commit a92610d
Show file tree
Hide file tree
Showing 6 changed files with 493 additions and 49 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: checkboxes
id: verify
attributes:
label: Check Existing Issues
description: |
Before submitting this issue, please confirm the following:
options:
- label: Yes, I have checked existing issues to ensure this problem hasn't already been reported.
required: true
- type: dropdown
id: instrument
attributes:
label: Instrument or Category
description: Which instrument or piece of code were you running?
multiple: true
options:
- NIRCam Stage 1/2 Pipeline
- MIRI Stage 1/2 Pipeline
- Image Tools
- PSF Subtraction
- Analysis Tools
- Other
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Please describe what happened and/or what you expected to happen.
placeholder: Describe the issue and/or expected outcome.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Error traceback output
description: Please copy and paste the full traceback of the error you encountered.
placeholder: Paste the error traceback here.
validations:
required: false
- type: input
id: OS
attributes:
label: What operating system are you using?
placeholder: E.g., Windows 11; Mac OS 10.10 El Capitan
- type: input
id: python_version
attributes:
label: What version of Python are you running?
description: If you're not sure, open a terminal with the environment you're running spaceKLIP in and type "python --version"
placeholder: E.g., Python 3.7
- type: textarea
id: package_list
attributes:
label: What Python packages do you have installed?
description: To get a full list, open a terminal with the environment you're running spaceKLIP in and type "conda list". Paste the full output here.
- type: textarea
id: additional-context
attributes:
label: Additional context or information
description: |
Provide any additional context or information that might be relevant to this issue.
placeholder: Add any additional context or information here.
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! After you submit this issue, check this GitHub thread for any updates/responses from the spaceKLIP team.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Documentation Issue or Request
description: Report issues or suggest improvements to the spaceKLIP documentation.
title: "[Documentation]: "
labels: ["documentation"]
body:
- type: checkboxes
id: verify
attributes:
label: Check Existing Issues
description: |
Before submitting this issue, please confirm the following:
options:
- label: Yes, I have checked existing issues to ensure this problem hasn't already been reported.
required: true
- type: textarea
id: problem-description
attributes:
label: Describe the issue or suggest an improvement
description: |
Please describe any issues with our documentation or suggest improvements. Your feedback is appreciated!
placeholder: Describe the issue or suggest improvements here.
validations:
required: true
- type: textarea
id: page-urls
attributes:
label: URLs of the documentation pages (if applicable)
description: |
If the issue is specific to particular pages, provide the URLs here.
This helps us locate and address the issue more efficiently. You can list multiple URLs if needed.
placeholder: Enter the URLs.
- type: textarea
id: additional-context
attributes:
label: Additional context or information
description: |
Provide any additional context or information that might be relevant to this issue or suggestion.
placeholder: Add any additional context or information here.
- type: markdown
attributes:
value: |
Thank you for helping us improve our documentation! After you submit this issue, check this GitHub thread for any updates/responses from the spaceKLIP team.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Enhancement Suggestion
description: Suggest an enhancement to spaceKLIP
title: "[Enhancement]: "
labels: ["enhancement"]
body:
- type: dropdown
id: instrument
attributes:
label: Instrument or Category
description: Which instrument or piece of code would you like to see improved?
multiple: true
options:
- NIRCam Stage 1/2 Pipeline
- MIRI Stage 1/2 Pipeline
- Image Tools
- PSF Subtraction
- Analysis Tools
- Other
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: What is your suggestion?
description: What feature would you like to see in spaceKLIP?
placeholder: It would be super helpful if spaceKLIP did...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Error traceback output
description: If relevant, please copy and paste the full traceback of any errors you encountered.
- type: input
id: OS
attributes:
label: What operating system are you using?
placeholder: E.g., Windows 11; Mac OS 10.10 El Capitan
- type: input
id: python_version
attributes:
label: What version of Python are you running?
description: If you're not sure, open a terminal with the environment you're running spaceKLIP in and type "python --version"
placeholder: E.g., Python 3.7
- type: textarea
id: package_list
attributes:
label: What Python packages do you have installed?
description: To get a full list, open a terminal with the environment you're running spaceKLIP in and type "conda list". Paste the full output here.
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest an enhancement! After you submit this issue, check this GitHub thread for any updates/responses from the spaceKLIP team.
14 changes: 14 additions & 0 deletions .github/workflows/autolabel.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: "Set Issue Label and Assignee"
on:
issues:
types: [opened]

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: Naturalclar/[email protected]
with:
title-or-body: "both"
parameters: '[ {"keywords": ["NIRCam Stage 1/2 Pipeline"], "labels": ["NIRCam"], "assignees": ["AarynnCarter","mperrin","JarronL"]}, {"keywords": ["MIRI Stage 1/2 Pipeline"], "labels": ["MIRI"], "assignees": ["AarynnCarter","mperrin","JarronL"]}, {"keywords": ["Image Tools"], "labels": ["image tools"], "assignees": ["kglidic","kammerje","AarynnCarter","wbalmer","kdlawson","JarronL"]}, {"keywords": ["PSF Subtraction"], "labels": ["PSF subtraction"], "assignees": ["kdlawson","wbalmer","AarynnCarter"]}, {"keywords": ["Analysis Tools"], "labels": ["analysis tools"], "assignees": ["kdlawson","wbalmer","AarynnCarter","juliengirard","kammerje","kglidic"]}, {"keywords": ["Other"], "labels": [], "assignees": ["kdlawson","AarynnCarter","juliengirard","JarronL","kglidic"]}, {"keywords": ["Documentation"], "labels": ["documentation"], "assignees": ["AarynnCarter","mperrin","kglidic"]}]'
github-token: "${{ secrets.GITHUB_TOKEN }}"
Loading

0 comments on commit a92610d

Please sign in to comment.