Skip to content

Commit e10de86

Browse files
committed
update contributing.md
1 parent 85b5d4d commit e10de86

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ discuss the feature/bug you intend to add/fix.
2020
2. Clone your fork to your local machine:
2121

2222
```bash
23-
git clone https://github.com/underctrl-io/commandkit.git
23+
git clone https://github.com/your_username/commandkit.git
2424
```
2525

2626
### Installing Dependencies
@@ -44,7 +44,8 @@ git checkout -b your-feature-or-bugfix
4444
2. Make your changes. Please make sure to use the
4545
[Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
4646
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.
4849

4950
3. Ensure that your changes don't break any existing functionality.
5051
You can test the functionality of your code depending on where
@@ -53,13 +54,14 @@ git checkout -b your-feature-or-bugfix
5354
the "apps/test-bot" project to test your own bot. Just make sure
5455
to create a new `.env` file with the template from the
5556
`.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.
5860
2. If you've made changes to the docs, you can run `pnpm dev`
5961
inside "apps/website" to spin up a local development server.
6062

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.
6365

6466
5. Commit your changes:
6567

@@ -73,7 +75,7 @@ git commit -m "Describe your change here"
7375
git push origin your-feature-or-bugfix
7476
```
7577

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).
7779
Describe your changes and any relevant information.
7880

7981
## Submitting Issues

0 commit comments

Comments
 (0)