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.

Sign up for GitHub

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

Update CONTRIBUTING.md #86

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Update CONTRIBUTING.md #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ This repository uses [bun](https://bun.sh/) to build and run unit tests, and [pl

We also do our best to keep things relatively type-safe.

If you're fixing a bug, ensure that all the tests still run after making your changes by running:
If you're fixing a bug, ensure the project still builds, and all the tests still run after making your changes by running:

```bash
bun run test && bun run e2e
bun run build && bun run test && bun run e2e
```

If you're adding a new feature, please add new tests to cover the feature's functionality. Most new features can probably be covered by adding a new test to `main.spec.ts`. One for the CSV output, and one for the TXT output.
If your new feature requires a new helper function in `helpers.ts`, add a test to cover the helper functionality as well.

Once your Pull Request is ready to be reviewed, it will go through a few automated checks to ensure tests pass and that the formatting is correct. Your Pull Request is only be merged once it's been reviewed, approved and the checks pass.
Once your Pull Request is ready to be reviewed, it will go through a few automated checks to ensure tests pass and that the formatting is correct. Your Pull Request will only be merged once it's been reviewed, approved and the checks pass.

## Conventions

Expand Down
Loading