You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developers/contributing/index.qmd
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Closing one of these may involve implementing new features, fixing bugs, or writ
15
15
16
16
You can also join the `#turing` channel on the [Julia Slack](https://julialang.org/slack/) and say hello!
17
17
18
-
If you are new to open-source software, please see [GitHub's introduction](https://guides.github.com/introduction/flow/) or [Julia's contribution guide](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md) on using version control for collaboration.
18
+
If you are new to opensource software, please see [GitHub's introduction](https://guides.github.com/introduction/flow/) or [Julia's contribution guide](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md) on using version control for collaboration.
19
19
20
20
### Documentation
21
21
@@ -47,7 +47,7 @@ This one would run all files with "optim" or "hmc" in their path, such as `test/
Or otherwise, set the global `ARGS` variable, and call `include("test/runtests.jl")`.
50
+
Alternatively, set the global `ARGS` variable, and call `include("test/runtests.jl")`.
51
51
52
52
### Pull requests, versions, and releases
53
53
@@ -56,11 +56,11 @@ To make a contribution to one of the Turing packages, fork it on GitHub, start a
56
56
Once you're done, open a pull request to the main repository under [TuringLang](https://github.com/TuringLang).
57
57
Someone from the dev team will review your code (if they don't, ping `@TuringLang/maintainers` in a comment to get their attention) and check that the continuous integration tests pass (with some allowed exceptions, see below).
58
58
If all looks good, we'll merge your PR with gratitude.
59
-
If not, we'll help you fix it and then merge it with gratitude
59
+
If not, we'll help you fix it and then merge it with gratitude.
60
60
61
61
Everything in this section about pull requests and branches applies to the Turing.jl and DynamicPPL.jl repositories.
62
62
Most of it also applies to other repositories under the TuringLang ecosystem, though some do not bother with the `main`/`breaking` distinction or with a `HISTORY.md`.
63
-
As of August 2025 we are slowly moving towards having all repos do the full process, so a new `HISTORY.md` in a repo that doesn't yet have one is always welcome.
63
+
As at August 2025 we are slowly moving towards having all repos do the full process, so a new `HISTORY.md` in a repo that doesn't yet have one is always welcome.
64
64
65
65
#### Branches
66
66
@@ -81,7 +81,7 @@ Meanwhile, breaking changes can be developed and merged into `breaking`, which i
81
81
Multiple breaking changes may be accumulated into `breaking`, before finally the `breaking`-to-`main` merge is done, and 0.20.0 is released.
82
82
On `breaking` the version number should then immediately be bumped to 0.21.
83
83
84
-
We do not generally back port of bug fixes, although we may consider doing so in special circumstances.
84
+
We do not generally backport bug fixes, although we may consider doing so in special circumstances.
85
85
86
86
#### Change history
87
87
@@ -101,7 +101,7 @@ CI checks other than tests and formatting serve various purposes, and some of th
101
101
Some examples are
102
102
103
103
- Anything running on a prerelease of Julia. These inform us of trouble ahead when that prerelease becomes an actual release, but don't require fixing for a PR to be merged.
104
-
- Any code coverage checks. Code coverate numbers can be helpful in catching missing tests or cases where the tests don't test what they are intended to. However, we do not insist on any particular coverage figures, since they are not a very good metric of a test suite's extensiveness.
104
+
- Any code coverage checks. Code coverage numbers can be helpful in catching missing tests or cases where the tests don't test what they are intended to. However, we do not insist on any particular coverage figures, since they are not a very good metric of a test suite's extensiveness.
105
105
- The benchmarks on DynamicPPL repo. These should be investigated to understand why they fail. If the reason is a bug in the PR, an actual test should be added to the test suite to catch it. However, sometimes they fail for unrelated reasons.
106
106
- Checks against some particular automatic differentiation backends. These are informative, telling us which backends have issues with which features, but often their breakage is beyond our control and we let it pass.
107
107
- The CI check in the `docs` repo for whether the docs are built with the latest Turing.jl release. This test failing is a reminder that we should make a PR to update to the latest version, but does not need fixing when working on a PR that makes unrelated changes to the documentation.
0 commit comments