Skip to content
Merged
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
8 changes: 5 additions & 3 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "9810f983b63cad4d9abfb6088a40617578a6d965",
"commit": "2a6434a5c749ecde69d00b937a3fef27ecbad656",
"checkout": null,
"context": {
"cookiecutter": {
Expand All @@ -22,19 +22,21 @@
"enable_dynamic_dev_versions": "y",
"include_example_code": "n",
"include_cruft_update_github_workflow": "n",
"use_pat_in_cruft_update_workflow": "y",
"use_extended_ruff_linting": "y",
"matrix_room_id": "",
"extra_ci_jobs": "",
"use_sunpy_pr_template": "y",
"_sphinx_theme": "sunpy",
"_parent_project": "",
"_install_requires": "",
"_copy_without_render": [
"docs/_templates",
"docs/_static",
".github/workflows/sub_package_update.yml"
".github/workflows/zizmor.yml"
],
"_template": "https://github.com/sunpy/package-template",
"_commit": "9810f983b63cad4d9abfb6088a40617578a6d965"
"_commit": "2a6434a5c749ecde69d00b937a3fef27ecbad656"
}
},
"directory": null
Expand Down
49 changes: 49 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Thank you for contributing to SunPy

## 🚨 IMPORTANT 🚨

We know that working on code and submitting pull requests takes effort, and we appreciate your time.
Thank you.

[Please be aware that everyone has to follow our code of conduct](https://sunpy.org/coc)

[Furthermore, you might need to check with your work place if you are allowed to contribute code](https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html)

- Please try to create an issue _before_ creating a Pull Request.
- Please use the following Git commit message style
- Use the future tense ("Adds feature" not "Added feature")
- Limit the first line to 72 characters or less
- **Do not post the output from Large Language Models or similar generative AI as code or comments on GitHub or any other platform.**
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
See our documentation on fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html).

We have several automatic features that run when a pull request is open.
They can appear daunting but do not worry about them!
[This a brief explanation of them.](https://docs.sunpy.org/en/latest/dev_guide/contents/pr_review_procedure.html#continuous-integration)

## ↑👆 DELETE above _before_ submitting 👆↑

## PR Description

<!--
Please include a summary of the changes and which issue will be addressed.
Please also include relevant motivation and context.
-->

## AI Assistance Disclosure

<!--
To support transparency and sustainable collaboration, please indicate whether AI-assisted tools were used in preparing this pull request.
Your pull request will not be reviewed until you have completed this checklist.
Removing this checklist may result in your pull request being automatically closed without a review.
For further details see our documentation on the fair and appropriate [usage of AI](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html).
-->

AI tools were used for:
- [ ] Code generation (e.g., when writing an implementation or fixing a bug)
- [ ] Test/benchmark generation
- [ ] Documentation (including examples)
- [ ] Research and understanding
- [ ] No AI tools were used

> Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability.
16 changes: 8 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ permissions: {}
jobs:
core:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1 # v3.0.2
permissions:
id-token: write
with:
submodules: false
coverage: codecov
toxdeps: "tox-pypi-filter"
coverage: codecov-oidc
toxdeps: tox-pypi-filter
posargs: -n auto
envs: |
- linux: py313
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

sdist_verify:
runs-on: ubuntu-latest
Expand All @@ -59,19 +59,19 @@ jobs:
test:
needs: [core, sdist_verify]
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1 # v3.0.2
permissions:
id-token: write
with:
submodules: false
coverage: codecov
toxdeps: "tox-pypi-filter"
coverage: codecov-oidc
toxdeps: tox-pypi-filter
posargs: -n auto
envs: |
- linux: py314
- windows: py312
- macos: py312
- linux: py312-oldestdeps
- linux: py314-devdeps
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

docs:
needs: [core]
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: GitHub Actions Security Analysis with zizmor

on:
push:
branches: ["main"]
pull_request:
branches: ["**"]

permissions: {}

jobs:
zizmor:
runs-on: ubuntu-latest
permissions:
security-events: write

steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- name: Run zizmor 🌈
uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2
6 changes: 1 addition & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
repos:
- repo: https://github.com/zizmorcore/zizmor-pre-commit
rev: v1.28.0
hooks:
- id: zizmor
# This should be before any formatting hooks like isort
# This should be before any formatting hooks like isort
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: "v0.16.1"
hooks:
Expand Down
Loading