Skip to content

Add testing to code principles #116

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

Open
johnwatson484 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add testing to code principles #116

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e4153c2
Add testing to code principles
johnwatson484 Jan 7, 2026
8cb10df
Reword bullets
johnwatson484 Jan 7, 2026
d5f13aa
Tweak statement
johnwatson484 Jan 9, 2026
6a2b26d
Amend supports
johnwatson484 Jan 9, 2026
9b5903c
Update wording
johnwatson484 Jan 16, 2026
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
10 changes: 10 additions & 0 deletions docs/principles/coding_principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,13 @@ They will not have the understanding and context you do at the time of writing i
### Code securely

> We incorporate good security practice in all our code

### We test our code
Copy link
Contributor

@ben-sagar ben-sagar Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these principles read like statements but some read like instructions - I feel we should try to get some consistency (although I don't have a good answer for this case!)


> We are always able to prove that our code works and functions correctly with a set of tests

- Acts as supporting documentation for the code
- Increases quality
- Provides confidence in the implementation
- Enables safe refactoring and code improvements
- Catches bugs early when they're cheaper to fix