Skip to content

Commit e9597f6

Browse files
authored
Merge pull request #347 from JuliaControl/doc_topology
doc: new control topology block diagram + `CONTRIBUTING.md`
2 parents 2fc5d59 + 6dc09bb commit e9597f6

File tree

6 files changed

+513
-4
lines changed

6 files changed

+513
-4
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing! This document provides guidelines for
4+
contributing to the project. If you have a problem to report or improvement to suggest
5+
please open an issue or open a pull request. To do so, please follow the instructions below.
6+
7+
## Reporting Issues
8+
9+
- Use GitHub Issues for bug reports and feature requests
10+
- Include a minimal reproducible example for bugs
11+
- Specify Julia version and package environment details
12+
13+
## Pull Requests
14+
15+
- Fork the repository and create a new branch for your changes
16+
- Write clear commit messages describing your changes
17+
- Ensure your code follows the project's coding style (see below)
18+
- Include tests for new features or bug fixes
19+
- Update documentation if necessary
20+
21+
## Code Style
22+
23+
- Try to follow the [Julia style guide](https://docs.julialang.org/en/v1/manual/style-guide/)
24+
- Use meaningful variable and function names
25+
- Mathematical symbols and unicode characters as variable names are encouraged if they are
26+
properly introduced in the documentation
27+
- Add docstrings to public functions using the standard Julia format
28+
29+
## Questions?
30+
31+
Feel free to open an issue or discussion if you have questions about contributing!

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "ModelPredictiveControl"
22
uuid = "61f9bdb8-6ae4-484a-811f-bbf86720c31c"
3-
version = "2.3.0"
3+
version = "2.3.1"
44
authors = ["Francis Gagnon"]
55

66
[deps]

0 commit comments

Comments
 (0)