Fundamental Documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- developer-experience, documentation
Research direction
Start with the checklist in this issue and the package template workflow it describes. Document creating a package with cookiecutter, CI, RTD, pre-commit and tox; then cover template updates using .sunpy-template.yml and migration away from astropy_helpers, including the linked APE17 guidance and _sunpy_init.py. Done means each checklist item has clear instructions.
Written by the indexing model from the issue text.
Description
Things we need to document here:
- Creating a new package using the template
- Install cookiecutter
- Run cookiecutter
- Answering questions, what they all mean etc
git init- How to use the CI configs, RTD and pre-commit
pre-commit(it runs as part of tox so needs to be run to make sure it passes).
- Updating a package with a new version of the template
.sunpy-template.yml- Run
cookiecutter --no-input --config-file .sunpy-template.yml - review diff, drop some changes, stage others.
- How to detect files removed by the template?
- Removal of astropy_helpers + upgrade from old templates.
- https://docs.astropy.org/projects/package-template/en/latest/ape17.html
- also
_sunpy_init.pyand other files no longer used.
- Dominant language
- Python
- Stars
- 3
- Forks
- 11
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sunpy/package-template
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
sunpy/package-template#133 ·
-
Feature Request
Difficulty 3/5 1-2 days Newbie friendliness 45/100
sunpy/package-template#98 ·
-
sunpy/package-template#96 · 4 comments · 1 assignee ·
-
Feature Request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
sunpy/package-template#65 ·
-
Feature Request
Difficulty 5/5 Over a week Newbie friendliness 25/100
sunpy/package-template#47 ·
All issues in sunpy/package-template
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100