Skip to content

Commit 73790eb

Browse files
Copilotyebai
andcommitted
Move development instructions from README to CONTRIBUTING.md
Co-authored-by: yebai <[email protected]>
1 parent 84b6061 commit 73790eb

File tree

1 file changed

+1
-28
lines changed

1 file changed

+1
-28
lines changed

README.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,7 @@ See the [documentation](https://turinglang.github.io/Bijectors.jl) for more.
1414

1515
## Development
1616

17-
### Running Tests Locally
18-
19-
To reproduce CI test failures locally, use the following commands:
20-
21-
```bash
22-
# Install dependencies
23-
julia --project=. -e "using Pkg; Pkg.instantiate()"
24-
25-
# Interface tests (reproduces "Interface tests" CI workflow)
26-
julia --project=. -e "ENV[\"GROUP\"] = \"Interface\"; using Pkg; Pkg.test()"
27-
28-
# AD tests with specific backend (reproduces "AD tests" CI workflow)
29-
# Replace "ReverseDiff" with the specific AD backend from the failing CI job
30-
julia --project=. -e "ENV[\"GROUP\"] = \"AD\"; ENV[\"AD\"] = \"ReverseDiff\"; using Pkg; Pkg.test()"
31-
32-
# Other AD backends available:
33-
# julia --project=. -e "ENV[\"GROUP\"] = \"AD\"; ENV[\"AD\"] = \"ForwardDiff\"; using Pkg; Pkg.test()"
34-
# julia --project=. -e "ENV[\"GROUP\"] = \"AD\"; ENV[\"AD\"] = \"Mooncake\"; using Pkg; Pkg.test()"
35-
# julia --project=. -e "ENV[\"GROUP\"] = \"AD\"; ENV[\"AD\"] = \"Tracker\"; using Pkg; Pkg.test()"
36-
# julia --project=. -e "ENV[\"GROUP\"] = \"AD\"; ENV[\"AD\"] = \"Enzyme\"; using Pkg; Pkg.test()"
37-
38-
# Run all tests
39-
julia --project=. -e "using Pkg; Pkg.test()"
40-
```
41-
42-
**Note**: When reproducing CI failures, ensure you use the correct environment variables (`GROUP` and `AD`) and always include `--project=.` in your Julia commands. These are required for the tests to run in the same configuration as CI.
43-
44-
For more detailed development instructions, see [CONTRIBUTING.md](CONTRIBUTING.md).
17+
For development instructions, including how to reproduce CI test failures locally, see [CONTRIBUTING.md](CONTRIBUTING.md).
4518

4619
## Do you want to contribute?
4720

0 commit comments

Comments
 (0)