chore: update-contributing-guidelines

.github/instructions/nx.instructions.md

@@ -4,19 +4,17 @@ applyTo: '**'
 
 // This file is automatically generated by Nx Console
 
-You are in an nx workspace using Nx 21.0.3 and pnpm as the package manager.
+You are in an nx workspace using Nx 21.1.1 and pnpm as the package manager.
 
 You have access to the Nx MCP server and the tools it provides. Use them. Follow these guidelines in order to best help the user:
 
 # General Guidelines
-
 - When answering questions, use the nx_workspace tool first to gain an understanding of the workspace architecture
 - For questions around nx configuration, best practices or if you're unsure, use the nx_docs tool to get relevant, up-to-date docs!! Always use this instead of assuming things about nx configuration
 - If the user needs help with an Nx configuration or project graph error, use the 'nx_workspace' tool to get any errors
 - To help answer questions about the workspace structure or simply help with demonstrating how tasks depend on each other, use the 'nx_visualize_graph' tool
 
 # Generation Guidelines
-
 If the user wants to generate something, use the following flow:
 
 - learn about the nx workspace and any specifics the user needs by using the 'nx_workspace' tool and the 'nx_project_details' tool if applicable
@@ -29,13 +27,21 @@ If the user wants to generate something, use the following flow:
 - wait for the user to finish the generator
 - read the generator log file using the 'nx_read_generator_log' tool
 - use the information provided in the log file to answer the user's question or continue with what they were doing
-  undefined
 
-# CI Error Guidelines
+# Running Tasks Guidelines
+If the user wants help with tasks or commands (which include keywords like "test", "build", "lint", or other similar actions), use the following flow:
+- Use the 'nx_current_running_tasks_details' tool to get the list of tasks (this can include tasks that were completed, stopped or failed).
+- If there are any tasks, ask the user if they would like help with a specific task then use the 'nx_current_running_task_output' tool to get the terminal output for that task/command
+- Use the terminal output from 'nx_current_running_task_output' to see what's wrong and help the user fix their problem. Use the appropriate tools if necessary
+- If the user would like to rerun the task or command, always use `nx run <taskId>` to rerun in the terminal. This will ensure that the task will run in the nx context and will be run the same way it originally executed
+- If the task was marked as "continuous" do not offer to rerun the task. This task is already running and the user can see the output in the terminal. You can use 'nx_current_running_task_output' to get the output of the task to verify the output. 
 
-If the user wants help with fixing an error in their CI pipeline, use the following flow:
 
+# CI Error Guidelines
+If the user wants help with fixing an error in their CI pipeline, use the following flow:
 - Retrieve the list of current CI Pipeline Executions (CIPEs) using the 'nx_cloud_cipe_details' tool
 - If there are any errors, use the 'nx_cloud_fix_cipe_failure' tool to retrieve the logs for a specific task
 - Use the task logs to see what's wrong and help the user fix their problem. Use the appropriate tools if necessary
 - Make sure that the problem is fixed by running the task that you passed into the 'nx_cloud_fix_cipe_failure' tool
+
+

.gitignore

@@ -76,3 +76,5 @@ packages/davinci-client/src/lib/mock-data/*.d.ts.map
 **/**/tsconfig.spec.vitest-temp.json
 
 test-output
+.cursor/rules/nx-rules.mdc
+.github/instructions/nx.instructions.md

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/ForgeRock/ping-javascript-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/ForgeRock/ping-javascript-sdk/actions/workflows/ci.yaml)
+[![Build Status](https://github.com/ForgeRock/ping-javascript-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/ForgeRock/ping-javascript-sdk/actions/workflows/ci.yml)
 
 <p align="center">
   <a href="https://github.com/ForgeRock/ping-javascript-sdk">
@@ -12,6 +12,18 @@ It offers a range of APIs for user authentication, user device management, and a
 
 Please visit our [ documentation ](https://docs.pingidentity.com/sdks/latest/sdks/index.html) site for more information.
 
+# Contributing
+
+Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute to the project
+
+Please note that because external contributors will not have an Nx access token, cloud caching will not work and you get warnings related to that. It should not prevent you from using the repository
+
+# Docs
+
+There are some internal docs located [here](./contributing_docs/) for guides about the repo, creating packages, releases, and testing.
+
+Our formal documentation can be found [docs.pingidentity.com/sdks](docs.pingidentity.com/sdks)
+
 # License
 
 This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details

package.json

@@ -4,9 +4,7 @@
   "private": true,
   "description": "Ping JavaScript SDK",
   "homepage": "https://github.com/ForgeRock/ping-javascript-sdk#readme",
-  "bugs": {
-    "url": "https://github.com/ForgeRock/ping-javascript-sdk/issues"
-  },
+  "bugs": { "url": "https://github.com/ForgeRock/ping-javascript-sdk/issues" },
   "repository": {
     "type": "git",
     "url": "https://github.com/ForgeRock/ping-javascript-sdk.git"
@@ -44,9 +42,7 @@
     ]
   },
   "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+    "commitizen": { "path": "./node_modules/cz-conventional-changelog" }
   },
   "dependencies": {},
   "devDependencies": {
@@ -64,16 +60,16 @@
     "@effect/vitest": "^0.6.7",
     "@eslint/eslintrc": "^3.0.0",
     "@eslint/js": "~9.25.0",
-    "@nx/devkit": "21.0.3",
-    "@nx/eslint": "21.0.3",
-    "@nx/eslint-plugin": "21.0.3",
-    "@nx/jest": "21.0.3",
-    "@nx/js": "21.0.3",
-    "@nx/playwright": "21.0.3",
-    "@nx/plugin": "21.0.3",
-    "@nx/vite": "21.0.3",
-    "@nx/web": "21.0.3",
-    "@nx/workspace": "21.0.3",
+    "@nx/devkit": "21.1.1",
+    "@nx/eslint": "21.1.1",
+    "@nx/eslint-plugin": "21.1.1",
+    "@nx/jest": "21.1.1",
+    "@nx/js": "21.1.1",
+    "@nx/playwright": "21.1.1",
+    "@nx/plugin": "21.1.1",
+    "@nx/vite": "21.1.1",
+    "@nx/web": "21.1.1",
+    "@nx/workspace": "21.1.1",
     "@playwright/test": "^1.47.2",
     "@swc-node/register": "1.10.10",
     "@swc/cli": "0.6.0",
@@ -104,7 +100,7 @@
     "jsonc-eslint-parser": "^2.1.0",
     "lint-staged": "^15.0.0",
     "madge": "8.0.0",
-    "nx": "21.0.3",
+    "nx": "21.1.1",
     "playwright": "^1.47.2",
     "prettier": "^3.2.5",
     "shx": "^0.4.0",
@@ -122,11 +118,6 @@
     "vitest-canvas-mock": "^0.3.3"
   },
   "packageManager": "[email protected]+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531",
-  "engines": {
-    "node": "^20 || ^22",
-    "pnpm": "9.15.9"
-  },
-  "nx": {
-    "includedScripts": []
-  }
+  "engines": { "node": "^20 || ^22", "pnpm": "9.15.9" },
+  "nx": { "includedScripts": [] }
 }