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/community/contributing.rst
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,19 @@ Now you have a development installation of Parcels, as well as a bunch of develo
84
84
Pixi workflows
85
85
~~~~~~~~~~~~~~
86
86
87
-
You can use the following Pixi commands to run common development tasks.
87
+
**Typical development workflow**
88
+
89
+
1. Make your code changes
90
+
2. Run ``pixi run lint`` to ensure code formatting and style compliance
91
+
3. Run ``pixi run tests`` to verify your changes don't break existing functionality
92
+
4. If you've added new features, run ``pixi run typing`` to check type annotations
93
+
5. If you've modified documentation, run ``pixi run docs`` to build and verify the docs
94
+
95
+
.. tip::
96
+
97
+
You can run ``pixi info`` to see all available environments and ``pixi task list`` to see all available tasks across environments.
98
+
99
+
See below for more Pixi commands relevant to development.
88
100
89
101
**Testing**
90
102
@@ -112,18 +124,6 @@ Parcels supports testing against different environments (e.g., different Python
112
124
113
125
The name of the workflow on GitHub contains the command you have to run locally to recreate the workflow - making it super easy to reproduce CI failures locally.
114
126
115
-
**Typical development workflow**
116
-
117
-
1. Make your code changes
118
-
2. Run ``pixi run lint`` to ensure code formatting and style compliance
119
-
3. Run ``pixi run tests`` to verify your changes don't break existing functionality
120
-
4. If you've added new features, run ``pixi run typing`` to check type annotations
121
-
5. If you've modified documentation, run ``pixi run docs`` to build and verify the docs
122
-
123
-
.. tip::
124
-
125
-
You can run ``pixi info`` to see all available environments and ``pixi task list`` to see all available tasks across environments.
0 commit comments