search

flatironinstitute / ccn-template

Template repository for CCN software projects
https://ccn-template.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
7 stars 2 forks source link

Issue templates #9

Open billbrod opened 1 year ago

billbrod commented 1 year ago

I think including issue templates would be helpful as well. At least one, for bug reports, that prompts the user to include their OS, python version, package version, reproducible example, etc. See plenoptic's for an example.

billbrod commented 1 year ago

Similarly, can create PR templates

billbrod commented 1 year ago

We can have separate templates for different types of issues/PRs, and they can include the specific content describes in #13 (e.g., what will the review checklist be)

EDIT: you can have multiple issue templates (and force users to use them by disallowing blank templates), but you can only have one PR template.

Common sections for PR templates: fixes (issue #), description (what), motivation (why), checklists

billbrod commented 1 year ago

Can also configure a template chooser, which allows you to place external links easily.

billbrod commented 1 year ago

Apparently you can also make saved replies (per user account, in your settings) for things like "get help here", "review checklist", "thanks for your PR"

unfortunately, can't create these on an org- or repo-level yet. but could write them out in the CONTRIBUTING document and tell maintainers to save them.