Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fundamental Documentation #2

Open
3 tasks
Cadair opened this issue Mar 19, 2020 · 0 comments
Open
3 tasks

Fundamental Documentation #2

Cadair opened this issue Mar 19, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Cadair
Copy link
Member

Cadair commented Mar 19, 2020

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.
@Cadair Cadair added the documentation Improvements or additions to documentation label Mar 19, 2020
Cadair added a commit that referenced this issue Oct 26, 2023
change from generic "packaging" to "python packaging"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant