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: docs/src/contributing/guide.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# [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](@refcontributing-guidelines).
3
3
4
4
## Project structure
5
5
@@ -14,11 +14,11 @@ In general, non-inference related functionality is implemented in `Rocket.jl` an
14
14
15
15
To familiarize yourself with development in `RxInfer`, we recommend the following steps:
16
16
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](@refcontributing-guidelines) to understand the contribution process and best practices for contributing to `RxInfer`, as well as coding practices and testing procedures.
18
18
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.
19
19
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.
20
20
21
21
## Contribution guidelines
22
22
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](@refcontributing-guidelines).
0 commit comments