@biggive/components 202309271411.0.0 → 202309281045.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +8 -4
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@biggive/components",
3
3
  "_comment": "Version number below is automatically replaced during CircleCI build.",
4
- "version": "202309271411.0.0",
4
+ "version": "202309281045.0.0",
5
5
  "description": "Big Give Components",
6
6
  "main": "dist/index.cjs.js",
7
7
  "module": "dist/index.js",
package/readme.md CHANGED
@@ -47,13 +47,17 @@ feature was set up, run `npm install` again.
47
47
 
48
48
  ### Dependencies and build output
49
49
 
50
- Anything externally managed should be loaded with npm and no copies checked into this codebase. We can use Stencil `copy` tasks and target app build strategies to get things in the right place.
50
+ Anything externally managed should be loaded with npm and no copies checked into this codebase. We can use Stencil `copy`
51
+ tasks and target app build strategies to get things in the right place.
51
52
 
52
53
  Generated build outputs should similarly be `.gitignore`d.
53
54
 
54
- Because Stencil components have *partly* generated readme docs, it is a good idea after changing any `@Prop`s or similar to `npm run build`
55
- before committing your changes. The docs should be source controlled as they can include manual content. If you make a new one, it's a good
56
- idea to add a one line description of its purpose to the readme before the generated section.
55
+ Because Stencil components have *partly* generated readme docs, after changing any `@Prop`s or similar it's
56
+ necessary to `npm run build` before committing your changes. The docs are source controlled as they can include manual
57
+ content. CircleCI will also run `npm run build` and fail if there are any changes required that were not committed.
58
+
59
+ If you make a new one, it's a good idea to add a one line description of its purpose to the readme before the
60
+ generated section.
57
61
 
58
62
  ### Output targets
59
63