@clipboard-health/ai-rules 2.2.4 → 2.3.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.
package/package.json
CHANGED
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
# Core Libraries
|
|
2
2
|
|
|
3
|
-
Clipboard's shared `@clipboard-health/*` libraries. Check here before adding new dependencies or implementing functionality from scratch.
|
|
3
|
+
Clipboard's shared `@clipboard-health/*` libraries. Check here before adding new dependencies or implementing functionality from scratch. For details on each library:
|
|
4
|
+
|
|
5
|
+
- For installed packages, check `node_modules/@clipboard-health/{LIBRARY_NAME}/README.md`
|
|
6
|
+
- For those not installed, use `gh api -H "Accept: application/vnd.github.raw" repos/ClipboardHealth/{core-utils OR cbh-core}/contents/packages/{LIBRARY_NAME}/README.md`
|
|
7
|
+
|
|
8
|
+
## Debugging
|
|
9
|
+
|
|
10
|
+
When a bug traces into a `@clipboard-health/*` library, read the source code in `node_modules/@clipboard-health/{LIBRARY_NAME}/` to find the root cause. Do not stop at the library boundary.
|
|
4
11
|
|
|
5
12
|
## core-utils
|
|
6
13
|
|
package/scripts/constants.js
CHANGED
|
@@ -17,7 +17,7 @@ exports.FILES = {
|
|
|
17
17
|
};
|
|
18
18
|
exports.RULE_FILES = {
|
|
19
19
|
"common/configuration": "Adding config, secrets, or third-party dependencies: SSM, LaunchDarkly, DB, NPM packages",
|
|
20
|
-
"common/coreLibraries": "Adding dependencies
|
|
20
|
+
"common/coreLibraries": "Adding dependencies, implementing functionality, or debugging errors involving a @clipboard-health/* library",
|
|
21
21
|
"common/featureFlags": "Creating or managing feature flags: naming, lifecycle, SDK usage, Zod schemas",
|
|
22
22
|
"common/gitWorkflow": "Writing commit messages, PR titles, or reviewing pull requests",
|
|
23
23
|
"common/loggingObservability": "Adding logging, metrics, monitoring, or observability: levels, context, PII, Datadog",
|