A cheat sheet for making PRs to sunpy?

[hayesla]

Describe the feature

It had been a while since I made some PRs to sunpy, and found it tricky to remember everything you need to do (checks/tests/changelogs etc).

It is well documented in the documentation, however I feel like it would be really useful to have a "cheatsheet" or quick guide to making PRs, with the step-by-step guide on what you have to do laid out exactly. The steps could also then point to the more detailed documentation on the docs. This could also include a "what you should do it figure-tests are failing" or common issues.

I don't know what everyone thinks - but I really do feel like this will be helpful and less overwhelming when trying to contribute, especially for newcomers or people not contributing regularly

Proposed solution

Make one?

[wtbarnes]

I wonder if this could be folded into the PR template itself, with maybe some links to the relevant parts of the dev guide.

[nabobalis]

Maybe if we delete the current PR template and have a link to a docs page/cheat sheet?

astropy have this page: https://docs.astropy.org/en/latest/development/workflow/development_workflow.html

I think we link to it in the newcomers guide.

[mwhv2]

Since starting with SunPy in January, I have been taking notes for myself on how to make PRs and how Github works since I was fairly new to it (still getting used to it). I have condensed the notes into a PR cheat sheet that I (try to) follow. I’d be happy to post it in a comment here or make a draft PR so everyone can add their thoughts.

[nabobalis]

Either works for me.

[Cadair]

That sounds great @mwhv2, A PR is probably easiest to comment on but either works :)