Add explanatory messages to files in src/styles

Shopify · Jul 5, 2019 · 1822133 · 1822133
1 parent 4b66609
commit 1822133
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/src/styles/_common.scss b/src/styles/_common.scss
@@ -1,3 +1,7 @@
+// This file is Polaris's private Sass API.
+// Within this codebase import this file if you wish to use our helper functions
+// Don't use this externally as it may change
+
 // stylelint-disable scss/partial-no-import
 
 @import './foundation/utilities';

diff --git a/src/styles/foundation.scss b/src/styles/foundation.scss
@@ -1,3 +1,7 @@
+// This file is part of Polaris's public Sass API.
+// Sewing Kit prepends every Component scss file with this file, making these
+// functions and mixins implicitly available.
+
 @import './foundation/utilities';
 @import './foundation/colors';
 @import './foundation/filters';

diff --git a/src/styles/shared.scss b/src/styles/shared.scss
@@ -1,3 +1,7 @@
+// This file is part of Polaris's public Sass API.
+// Sewing Kit prepends every Component scss file with this file, making these
+// functions and mixins implicitly available.
+
 @import './shared/accessibility';
 @import './shared/breakpoints';
 @import './shared/buttons';