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: source/contributing_guide/index.rst
+2-27Lines changed: 2 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ If you added something to Ariel that you would like to share with other people,
9
9
The first time you make a contribution to a Ariel package your PR should add your name to the ``authors`` list in that package's ``pyproject.toml``.
10
10
**Only open PRs on the** ``development`` **-branch!** And make sure that only your commits are present, otherwise do a rebase.
11
11
12
-
Note that a general heuristic is, if your addition adds a dependency of another revolve package to the existing dependencies, you might not want to structure it that way.
12
+
Note that a general heuristic is, if your addition adds a dependency of another ARIEL package to the existing dependencies, you might not want to structure it that way.
13
13
For a guideline what can depend on what, look at the package diagram on the main page.
14
14
15
15
**Important Information before merging your PRs:**
@@ -33,32 +33,7 @@ You cannot directly run the CI configuration locally, but scripts are available
33
33
----------
34
34
Code tools
35
35
----------
36
-
Ariel code quality is checked by a variety of tools. See the ``codetools`` directory.
37
-
The CI runs these tools automatically.
38
-
A shorthand for running the tools and applying as many automatic fixes as possible is ``./codetools/fix_all.sh``.
39
-
Not all problems can be fixed automatically, but the errors should be self explanatory.
40
-
Make sure to regularly run the tools during development (at least mypy), as they can help you detect many mistakes early.
41
-
42
-
.. list-table:: Ariel code tools
43
-
:widths: 1 4
44
-
:header-rows: 1
45
-
46
-
* - Tool
47
-
- Description
48
-
* - Black
49
-
- Python code formatting.
50
-
* - Darglint
51
-
- Check if python docstrings match what they are documenting.
52
-
* - Isort
53
-
- Sorts python imports.
54
-
* - Mypy
55
-
- Static type checker for Python.
56
-
* - Pydocstyle
57
-
- Makes docstrings conform to a single style. Mostly used to check for missing docstrings.
58
-
* - Pyflakes
59
-
- Finds simple errors in Python code. Mostly used to check for unused imports.
Copy file name to clipboardExpand all lines: source/introduction_to_modular_robots/index.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,8 @@ This introduction applies to V2 robots. V1 robots are only used internally in CI
9
9
10
10
Modular robots are robots built from a set of modules and sensors.
11
11
A central brain controls the robot, which can read the sensors.
12
-
The modular robots system in Revolve2 is based on the RoboGen system (*RoboGen: Robot Generation through Artificial Evolution, ser. Artificial Life Conference Proceedings, vol. ALIFE 14: The Fourteenth International Conference on the Synthesis and Simulation of Living Systems, 07 2014*).
13
-
It is possible to adjust Revolve2 to include modules and sensors not readily available in the standard set.
12
+
The modular robots system in ARIEL is based on the RoboGen system (*RoboGen: Robot Generation through Artificial Evolution, ser. Artificial Life Conference Proceedings, vol. ALIFE 14: The Fourteenth International Conference on the Synthesis and Simulation of Living Systems, 07 2014*).
13
+
It is possible to adjust ARIEL to include modules and sensors not readily available in the standard set.
0 commit comments