Skip to content

Commit ed94db8

Browse files
committed
improve links
1 parent 1d45785 commit ed94db8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/src/contributing/guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# [Contributing](@id contributing-overview)
2-
Welcome to the contribution guide for `RxInfer.jl`. Here you'll find information on the `RxInfer` project structure, and how to get started with contributing to the project. For more practical instructions and guidelines, refer to the [contribution guidelines](https://reactivebayes.github.io/RxInfer.jl/stable/contributing/guidelines.html).
2+
Welcome to the contribution guide for `RxInfer.jl`. Here you'll find information on the `RxInfer` project structure, and how to get started with contributing to the project. For more practical instructions and guidelines, refer to the [contribution guidelines](@ref contributing-guidelines).
33

44
## Project structure
55

@@ -14,11 +14,11 @@ In general, non-inference related functionality is implemented in `Rocket.jl` an
1414

1515
To familiarize yourself with development in `RxInfer`, we recommend the following steps:
1616
1. Familiarize yourself with the collaborative tools used in the project. `RxInfer` uses GitHub for version control, issue tracking, and pull requests. We aim to maintain the [good first issue](https://github.com/ReactiveBayes/RxInfer.jl/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label on issues that are suitable for new contributors. Furthermore, the core development team tracks the project's progress and development tasks on the [project board](https://github.com/orgs/ReactiveBayes/projects/2/views/4). Because the project board is overwhelming, we recommend focusing first on issues labeled with the `good first issue` label.
17-
2. Read the [contribution guidelines](https://reactivebayes.github.io/RxInfer.jl/stable/contributing/guidelines.html) to understand the contribution process and best practices for contributing to `RxInfer`, as well as coding practices and testing procedures.
17+
2. Read the [contribution guidelines](@ref contributing-guidelines) to understand the contribution process and best practices for contributing to `RxInfer`, as well as coding practices and testing procedures.
1818
3. Familiarize yourself with the `RxInfer` codebase and its core dependencies. While most information can be found on the `RxInfer` documentation page, it is also recommended to read the documentation for `Rocket.jl`, `GraphPPL.jl`, and `ReactiveMP.jl` to understand the core functionality and design principles of the project.
1919
4. Pick an issue to work on. We recommend starting with a `good first issue` to familiarize yourself with the contribution process. Once you're comfortable with the process, you can move on to more complex issues.
2020

2121
## Contribution guidelines
2222

23-
The contribution guidelines provide detailed instructions on how to contribute effectively to the project. They cover reporting bugs, suggesting features, and contributing code. For more information, refer to the [contribution guidelines](https://reactivebayes.github.io/RxInfer.jl/stable/contributing/guidelines.html).
23+
The contribution guidelines provide detailed instructions on how to contribute effectively to the project. They cover reporting bugs, suggesting features, and contributing code. For more information, refer to the [contribution guidelines](@ref contributing-guidelines).
2424

0 commit comments

Comments
 (0)