Skip to content

Commit e9ea455

Browse files
committed
Move up 'Typical dev workflow' section
1 parent ca4817b commit e9ea455

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/community/contributing.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,19 @@ Now you have a development installation of Parcels, as well as a bunch of develo
8484
Pixi workflows
8585
~~~~~~~~~~~~~~
8686

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.
88100

89101
**Testing**
90102

@@ -112,18 +124,6 @@ Parcels supports testing against different environments (e.g., different Python
112124

113125
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.
114126

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.
126-
127127

128128
Changing code
129129
~~~~~~~~~~~~~

0 commit comments

Comments
 (0)