Skip to content
583 changes: 3 additions & 580 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/blog/displacement-vectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you need a drop-in replacement for the old behaviour, you can use:

__Related changes__

We slightly modified the behaviour of vector conversion from Cartesian to polar coordinates. For simplicity and interpretability, {func}`cart2pol <movement.utils.vector.cart2pol>` now always sets the angle `phi` to 0 when the vector's norm `rho` is 0, rather than following the [C standard](https://www.iso.org/standard/29237.html) for [`arctan2`](https://en.wikipedia.org/wiki/Atan2). This change should not affect existing workflows, as a zero-length vector has an undefined direction—meaning it could point in any direction, and assigning `phi = 0` is a safe, neutral choice.
We slightly modified the behaviour of vector conversion from Cartesian to polar coordinates. For simplicity and interpretability, {func}`cart2pol <movement.utils.vector.cart2pol>` now always sets the angle `phi` to 0 when the vector's norm `rho` is 0, rather than following the [C standard](https://www.iso.org/standard/82075.html) for [`arctan2`](https://en.wikipedia.org/wiki/Atan2). This change should not affect existing workflows, as a zero-length vector has an undefined direction—meaning it could point in any direction, and assigning `phi = 0` is a safe, neutral choice.

## Reflections

Expand Down
551 changes: 551 additions & 0 deletions docs/source/community/contributing.md

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions docs/source/community/contributing.rst

This file was deleted.

31 changes: 29 additions & 2 deletions docs/source/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,35 @@ We welcome and encourage contributions in any form—whether it is fixing a bug,
developing a new feature, or improving the documentation—as long as you follow our
[code of conduct](target-code-of-conduct).

To help you get started, we have prepared a statement on the project's [mission and scope](target-mission),
a [roadmap](target-roadmaps) outlining our current priorities, and a detailed [contributing guide](target-contributing).
To help you get started, we have prepared a list of resources and guidelines. Connect with us
through our [communication channels](target-connect-with-us) if you have any questions or need assistance.

::::{grid} 2
:::{grid-item-card} {fas}`users;sd-text-primary` About the project

Meet the team and learn about the project's context, goals, and future plans.

- [People](target-people)
- [Mission & Scope](target-mission)
- [Roadmaps](target-roadmaps)
- [Related Projects](target-related-projects)
- [Resources](target-resources)
- [Code of Conduct](target-code-of-conduct)
- [License](target-license)
:::

:::{grid-item-card} {fas}`code-branch;sd-text-primary` How to Contribute

Learn how to set up your development environment and contribute code or documentation.

- [Before you start](target-before-you-start)
- [Contribution workflow](target-contribution-workflow)
- [Development guidelines](target-dev-guidelines)
- [Contributing documentation](target-contributing-docs)
- [Sample data](target-contributing-sample-data)
:::
::::


(target-connect-with-us)=
## Connect with us
Expand Down
1 change: 1 addition & 0 deletions docs/source/community/license.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(target-license)=
# License

[The 3-Clause BSD License](https://opensource.org/license/bsd-3-clause/)
Expand Down
1 change: 1 addition & 0 deletions docs/source/community/related-projects.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(target-related-projects)=
# Related projects

The following projects cover related needs and served as inspiration for this project:
Expand Down
Loading