Skip to content

Commit 6f19ad6

Browse files
committed
docs: improve testing section in CONTRIBUTING.md
Restore the witty ~~complex~~ sophisticated strikethrough and tighten prose while preserving voice. Move TESTING.md reference to end of section as a natural "learn more" exit ramp.
1 parent f5ea00d commit 6f19ad6

1 file changed

Lines changed: 9 additions & 14 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -137,26 +137,21 @@ then use this local image to test Dgraph in your local Docker setup.
137137

138138
### Testing
139139

140-
For comprehensive testing documentation, see [TESTING.md](TESTING.md).
140+
Dgraph employs a ~~complex~~ sophisticated testing framework with extensive test coverage. A full
141+
test run can take several hours. We've developed a custom test runner in Go in the [t/](t)
142+
directory, providing control and flexibility beyond the standard Go testing framework.
141143

142-
Dgraph employs a sophisticated testing framework that includes extensive test coverage. Due to the
143-
comprehensive nature of these tests, a complete test run can take several hours, depending on your
144-
hardware. To manage this complex testing process efficiently, we've developed a custom test
145-
framework implemented in Go, which resides in the [./t](/t) directory.
146-
147-
For dependencies, runner flags and instructions for running tests on non-Linux machines, see the
148-
[README](t/README.md) in the [_t_](t) folder.
149-
150-
Quick start:
144+
Unit tests for core packages can be run directly:
151145

152146
```bash
153-
# Run unit tests
154147
go test github.com/dgraph-io/dgraph/v25/dql
155-
156-
# Run integration tests (requires Docker)
157-
cd t && go build . && ./t --suite=unit
158148
```
159149

150+
Other integration tests are defined in [.github/workflows](.github/workflows). See
151+
[t/README.md](t/README.md) for dependencies, runner flags, and cross-platform instructions.
152+
153+
For a comprehensive testing guide, see [TESTING.md](TESTING.md).
154+
160155
## Contributing
161156

162157
### Guidelines

0 commit comments

Comments
 (0)