Make a development guide

[settwi]

We need a guide that says how to initialize a dev environment and run it properly. It could just be a markdown file on GitHub; it doesn't need to necessarily be an offical document that we put into Sphinx. It would be good to link to relevant documentation as well in case something breaks in the future.

There are several tools used to check the code:

• tox (which manages the rest of them)
• ruff
• buildthedocs/sphinx
• isort
• codecov
• GH actions & their configurations
• pytest
• pre-commit
• ...?

It's not immediately clear what all is required. For instance

• do we need isort if we have ruff?
• Should we have a setup.py when we have a pyproject.toml?

Let's document how things work, decide what we need/don't need, then remove what we don't?

[Cadair]

As almost all of these are standard across the sunpy maintained packages, we should be documenting these things in either the core development guide: https://docs.sunpy.org/en/latest/dev_guide/index.html or the package-template documentation.

Unfortunately, we ran out of time on the package template project before we got to through documentation, but we have some here: https://docs.sunpy.org/projects/package-template/en/latest/

[settwi]

As almost all of these are standard across the sunpy maintained packages, we should be documenting these things in either the core development guide: https://docs.sunpy.org/en/latest/dev_guide/index.html or the package-template documentation.

Unfortunately, we ran out of time on the package template project before we got to through documentation, but we have some here: https://docs.sunpy.org/projects/package-template/en/latest/

This is a good start, I think it would be good to have a page dedicated to the tools that tox manages too.

Still, I'm wondering, do we need isort if we have ruff, for instance? I think adding documentation about the individual tools/what they do would help answer that question.

Also, it might be nice to have a more fleshed-out index page rather than just the headers generated by Sphinx, like a paragraph or section of bullet points describing where to go if you are curious about different parts of the packaging process.

Edit: maybe the summary could be on the readme or wiki ?

[settwi]

Along these lines, should we bump the minimum required version here?

sunkit-spex/.sunpy-template.yml

Line 11 in 59a6472

minimum_python_version: "3.7"

Are there other spots where a minimum version is written?