@@ -15,14 +15,10 @@ Contents:
15
15
Packages
16
16
========
17
17
18
- TODO: Put ` beacon ` in ` dom `
18
+ TODO: Pending discussion in #545
19
+
19
20
TODO: Put DOMParser in ` dom ` with its extra types in its companion object
20
- TODO: Put ` gamepad ` in ` dom `
21
- TODO: Put ` push ` in ` dom ` ? Everything is ` Push* ` . Or will there be ` Push* ` from other APIs too? Do we care?
22
- TODO: Put ` sharedworkers ` in ` dom `
23
- TODO: Put ` storage ` in ` dom ` ? Does it really warrant its own package?
24
21
TODO: Put ` webgl/extensions ` in ` webgl `
25
- TODO: The ` ext ` package is named confusingly imo. Ideally we could rename it to something clearer.
26
22
27
23
```
28
24
org.scalajs.dom — All top-level facades
@@ -60,6 +56,8 @@ Facades
60
56
=======
61
57
62
58
If a feature has many types that don't share a common unambiguous prefix (like ` crypto ` ),
59
+ * firstly, please raise an issue to discuss so that you don't do work only to be asked to undo it
60
+ during PR review
63
61
* create a feature package
64
62
* put all of its types in its package
65
63
@@ -81,8 +79,9 @@ Non-Facades
81
79
* Add Scala-only utilities that pertain to a specific facade, in the facades companion object
82
80
Eg: helper constructors, legal facade values.
83
81
84
- * Add Scala-only utilities that don't pertain to a specific facade, or shouldn't be universally
85
- available (subjective judgement here) in the ` ext ` package.
82
+ * We currently don't see the need for Scala-only utilities that don't pertain to a specific facade,
83
+ or shouldn't be universally available (subjective judgement here).
84
+ If you believe you've got a compelling use case please raise an issue first to discuss.
86
85
87
86
88
87
Partially-Supported DOM API
@@ -94,7 +93,7 @@ TODO: Pending discussion in #514
94
93
Binary Compatibility
95
94
====================
96
95
97
- Binary compatibility for Scala.JS facades is different than standard Scala.
96
+ Binary compatibility for Scala.js facades is different than standard Scala.
98
97
The following are changes that are indeed incompatible in both formats:
99
98
100
99
Don't:
@@ -117,8 +116,16 @@ Submitting a PR
117
116
Once you're done making your changes...
118
117
119
118
1 . Run ` sbt prePR `
119
+
120
120
2 . Run ` git diff api-reports ` and ensure that you aren't breaking backwards-binary-compatibility
121
- (see above). We'll probably automate this step in the future (See #503 )
121
+ (see above). The api reports are auto-generated by ` prePR ` and provide a concise summary of the
122
+ entire API. Make sure to look at the top of the file for a description of format.
123
+
124
+ Note: We might automate binary-compatibility checking in the future (See #503 ) but for now,
125
+ it's just a helpful tool for reviewing PRs.
126
+
122
127
3 . Check in and commit the changes to ` api-reports `
128
+
123
129
4 . Submit your PR
130
+
124
131
5 . Know that your contribution is appreciated, thank you!
0 commit comments