Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/community/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,19 @@ Now you have a development installation of Parcels, as well as a bunch of develo
Pixi workflows
~~~~~~~~~~~~~~

You can use the following Pixi commands to run common development tasks.
**Typical development workflow**

1. Make your code changes
2. Run ``pixi run lint`` to ensure code formatting and style compliance
3. Run ``pixi run tests`` to verify your changes don't break existing functionality
4. If you've added new features, run ``pixi run typing`` to check type annotations
5. If you've modified documentation, run ``pixi run docs`` to build and verify the docs

.. tip::

You can run ``pixi info`` to see all available environments and ``pixi task list`` to see all available tasks across environments.

See below for more Pixi commands relevant to development.

**Testing**

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

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.

**Typical development workflow**

1. Make your code changes
2. Run ``pixi run lint`` to ensure code formatting and style compliance
3. Run ``pixi run tests`` to verify your changes don't break existing functionality
4. If you've added new features, run ``pixi run typing`` to check type annotations
5. If you've modified documentation, run ``pixi run docs`` to build and verify the docs

.. tip::

You can run ``pixi info`` to see all available environments and ``pixi task list`` to see all available tasks across environments.


Changing code
~~~~~~~~~~~~~
Expand Down