Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: contributing update #73

Merged
merged 2 commits into from
Dec 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,34 @@ To get started with contributing, please follow these steps:
5. Commit your changes and push them to your forked repository.
6. Open a pull request to the main repository.

### Running Tests

The project uses Mocha for testing. To run the test suite:

1. Run all tests: `npm test`
2. Run specific test file: `npm test -- path/to/test`

When writing tests:

- Place test files in `src/test/suite/`
- Use the naming convention `*.test.ts`
- Group related tests using `suite()` and `test()`
- Keep tests focused and simple
- Mock external dependencies
- Use descriptive test names that explain the expected behavior

Example test structure:

```typescript
suite('Feature Name', () => {
test('should handle specific case', async () => {
// Arrange
// Act
// Assert
});
});
```

### Running the extension

Open the extension project in VS Code (e.g. by running `code .` in the project folder).
Expand Down
Loading