You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* improve the important notes for ai once more
* Correct capitalization of "Checkly" in important notes and clarify instructions for storing environment variables and secrets using Checkly's CLI.
Copy file name to clipboardExpand all lines: site/layouts/_default/index.txt
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,13 @@ Important notes:
13
13
- For backend projects identify all resources which can be tested
14
14
- For frontend projects identify all pages and user journeys which can be tested
15
15
- Understand the authentication setup for the users app so you can support it
16
-
- Store required credentials in checkly
17
-
- Make sure to guide the user when setting up a new project, always create the project structure manually, do not use the cli (npm create checkly@latest)
18
-
- If the project is a backend project generate api checks or multistep api checks for more complex api testing scenarios, cover as many resources as possible
16
+
- Store required credentials in Checkly
17
+
- Make sure to guide the user when setting up a new project, use the `npm create checkly@latest` command to get started
18
+
- To generate the first checks/tests explain the user the available check types and ask them which one they want to use
19
19
- Make sure to only use npm packages in scripts which are available in Checkly runtimes, Checkly doesn't support all npm packages
20
+
- never use the imports in the namespace @checkly. they are outdated. Always import from 'checkly/constructs'
21
+
- make sure that generated test files names match the patterns set in Checkly config file
22
+
- make sure when using environment variables or secrets to store them in Checkly using Checkly's cli
0 commit comments