aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/design_considerations.md
blob: cca209d81b3d1e64ddca4d1519c35ee2c4a07f33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
name: Design considerations
about: We didn't think things through?
title: ''
labels: design
assignees: ''

---

<!--
This is a place for issue reports that are not exactly bugs (wrong unintentional behavior) but for our library behaving suboptimally (though this could have been intentional).

**Double-check**

* If the behavior is strange, surprising, and undocumented, it could be a good idea to file a "Bug report" instead.
* Is this still relevant with the latest version of the library? We could have changed this already.
* Maybe there are good reasons for the existing behavior. Please try searching for existing discussions of the problem.
* Are you using the right abstraction? Consider asking on [StackOverflow](https://stackoverflow.com/) or the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up). Maybe your need is better solved by some other abstraction entirely.

-->

**What do we have now?**

Preferably with specific code examples.

**What should be instead?**

Preferably with specific code examples.

**Why?**

The upsides of your proposal.
* Who would benefit from this and how?
  - Would it be possible to cover new use cases?
  - Would some code become clearer?
  - Would the library become conceptually simpler?
  - etc.

**Why not?**

The downsides of your proposal that you already see.
* Is this a breaking change?
* Are there use cases that are better solved by what we have now?
* Does some code become less clear after this change?
* etc.