search

pointfreeco / swift-snapshot-testing

📸 Delightful Swift snapshot testing.
https://www.pointfree.co/episodes/ep41-a-tour-of-snapshot-testing
MIT License
3.77k stars 578 forks source link

Add Issue/Pull Request Templates #175

Closed stephencelis closed 4 years ago

stephencelis commented 5 years ago

It'd be nice to capture frequently asked questions, like the fact that the same simulator must be used on CI.

marcosgriselli commented 5 years ago

I like the issue template on https://github.com/stevemao/github-issue-templates/blob/master/no-duplicates/ISSUE_TEMPLATE.md with some adjustments. Adding a few fields encourages the author to think about his issue from a different angle and even find alternatives he didn't consider before.

⬇️

Your issue may already be reported! Please search on the issue track before creating one.

Expected Behavior

Current Behavior

Possible Solution

Steps to Reproduce (for bugs)

1. 2. 3. 4.

Context

Environment

ISSUE_TEMPLATE.md.zip

marcosgriselli commented 5 years ago

Creating a FAQ document can probably be an iterative process. Push a FAQ section with 1 or 2 Q&As and keep adding them as users repeat the same questions. Plus it will let contributors send small PRs adding new Q&As so no one gets the task of writing it entirely on their own.

stephencelis commented 4 years ago

Thanks for the suggestions! This isn't a super high-priority thing right now so I'm going to close, but with our recent open-sourcing of swift-composable-architecture it's something we'd like to solve for there, too. So we'll hopefully address in the near future!