@@ -20,7 +20,7 @@ discuss the feature/bug you intend to add/fix.
20
20
2 . Clone your fork to your local machine:
21
21
22
22
``` bash
23
- git clone https://github.com/underctrl-io /commandkit.git
23
+ git clone https://github.com/your_username /commandkit.git
24
24
```
25
25
26
26
### Installing Dependencies
@@ -44,7 +44,8 @@ git checkout -b your-feature-or-bugfix
44
44
2 . Make your changes. Please make sure to use the
45
45
[ Prettier] ( https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode )
46
46
extension for consistent formatting and comments wherever
47
- necessary.
47
+ necessary. Alternatively, you can run ` pnpm prettier:format ` after
48
+ you've made your changes.
48
49
49
50
3 . Ensure that your changes don't break any existing functionality.
50
51
You can test the functionality of your code depending on where
@@ -53,13 +54,14 @@ git checkout -b your-feature-or-bugfix
53
54
the "apps/test-bot" project to test your own bot. Just make sure
54
55
to create a new ` .env ` file with the template from the
55
56
` .env.example ` file provided. This also requires you to build
56
- the commandkit package locally (after you make your changes)
57
- because it's symlinked with pnpm workspaces.
57
+ the CommandKit package (at ` packages/commandkit ` ) locally (after
58
+ you make your changes) because it's symlinked with pnpm
59
+ workspaces.
58
60
2 . If you've made changes to the docs, you can run ` pnpm dev `
59
61
inside "apps/website" to spin up a local development server.
60
62
61
- 4 . Run ` pnpm lint ` from the root directory to ensure all lint scripts
62
- and formatting is valid.
63
+ 4 . Run ` pnpm check-types ` and ` pnpm prettier:check ` from the root
64
+ directory to ensure all type checking and formatting is valid.
63
65
64
66
5 . Commit your changes:
65
67
@@ -73,7 +75,7 @@ git commit -m "Describe your change here"
73
75
git push origin your-feature-or-bugfix
74
76
```
75
77
76
- 7 . Open a pull request in the main project repository (main branch).
78
+ 7 . Open a pull request in the main project repository (` main ` branch).
77
79
Describe your changes and any relevant information.
78
80
79
81
## Submitting Issues
0 commit comments