Skip to content

Commit 124f700

Browse files
authored
Add testing and code quality guidelines to CONTRIBUTING.md (#2685)
Add explicit requirements for testing (E2E and unit tests) and code quality expectations including PR size limits, code review responsibilities, and manual testing requirements. Signed-off-by: Juan Antonio Osorio <[email protected]>
1 parent c8c90f0 commit 124f700

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,25 @@ are a great place to start!
6969
- Once approved, all of your commits will be squashed into a single commit with
7070
your PR title.
7171

72+
### Testing requirements
73+
74+
- Add end-to-end tests for new features covering both API and CLI flows.
75+
- Write unit tests for new code alongside the source files.
76+
77+
### Code quality expectations
78+
79+
Pull request authors are responsible for:
80+
81+
- Keeping PRs small and focused. PRs exceeding 1000 lines may be blocked and
82+
require splitting into multiple PRs or logical commits before review. If a
83+
large PR is unavoidable, include an explanation in the PR description
84+
justifying the size and describing how the changes are organized for review.
85+
- Reviewing all submitted code, regardless of whether it's AI-generated or
86+
hand-written.
87+
- Manually testing changes to verify new or existing features work correctly.
88+
- Ensuring coding style guidelines are followed.
89+
- Respecting architecture boundaries and design patterns.
90+
7291
### Contributing to docs
7392

7493
The ToolHive user documentation website is maintained in the

0 commit comments

Comments
 (0)