search

astropy / package-template

Template for packages that use Astropy. Maintainer: @astrofrog
http://docs.astropy.org/projects/package-template/en/latest/
Other
60 stars 63 forks source link

Add PR template to rendered project #485

Closed nstarman closed 11 months ago

nstarman commented 3 years ago

I think this is one of those things that's easier to remove than add if the user doesn't find it useful.

I took the Astropy PR template and turned it into a checklist. I currently use this on my new projects, especially private repos where the Astropy-bot can't check the changelog. The checklist can definitely be improved, but this has been a useful to me thus far.

Signed-off-by: Nathaniel Starkman nstarkman@protonmail.com

nstarman commented 3 years ago

@astrofrog, @pllim, @bsipocz Any suggestions for the PR checklist? (I think this PR can be tagged wtih "no-changelog-needed").

I've been looking for a way to make the Code of Conduct and other links be set by cookiecutter, but there's really no way of knowing if the new repo will implement its own. I think defaulting to the Astropy docs is a good default.

bsipocz commented 3 years ago

Hmm, I can't remember now what I was referring, to. Some only has text and links like astropy and numpy, sunpy (https://github.com/sunpy/.github/blob/master/%20PULL_REQUEST_TEMPLATE.md), some others have the checklists type of things.

E.g. the conda-forge bot does this checklist for all automated PRs: https://github.com/conda-forge/.github/blob/master/.github/PULL_REQUEST_TEMPLATE.md

matplotlib: https://github.com/matplotlib/matplotlib/blob/master/.github/PULL_REQUEST_TEMPLATE.md

pymc3: https://github.com/pymc-devs/pymc3/blob/master/.github/PULL_REQUEST_TEMPLATE.md

nstarman commented 3 years ago

@pllim Git blame does not pick up on your suggested edits, so I'm squashing the commits.

@bsipocz Thanks for the templates. The Matplotlib one was particularly relevant.

nstarman commented 3 years ago

Adding a template for rendered projects without having it apply here struck me as funny. Rectified.

nstarman commented 3 years ago

@astrofrog , @bsipocz, @Cadair. Thoughts?

I would also love to see this checklist on main Astropy, with an additional checklist item: "-[ ] should this also be added to the package template? (delete this if not)", and the astropy PR-bot would open an issue here if the person checked the box.

nstarman commented 2 years ago

@pllim, looks like no comments 🙃 .

pllim commented 2 years ago

Thanks for the ping. I think this now needs a small update after we changed master branch name to main.

pllim commented 11 months ago

See https://github.com/astropy/package-template#deprecation-warning