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

Jump to bottom

Add information on test-driven development to contributing guidelines #386

Open

tsalo opened this issue Jan 16, 2025 · 0 comments

Labels

Member

tsalo commented Jan 16, 2025

Our contributing guidelines don't have much information on our preferred coding style or the TDD practices that we're trying to adopt.

The basic approach to fixing bugs should be:

Write a test that fails because of the current bug.
Try to cover all reasonable inputs and branching logic of the function in question.
Open a PR with the new/updated test that fails.
Implement a fix.
Push the fix.

tsalo added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment