Skip to content

docs: add tips on contributing #4391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

docs: add tips on contributing #4391

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
402733b
docs: add tips on contributing
euri10 Oct 3, 2025
623d06e
til sphinx doesnt like duplicate explicit targets
euri10 Oct 3, 2025
dac2d64
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
88011fc
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
a15e4e6
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
46efb32
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
d7dcc32
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
8fba15c
uv at the top !!
euri10 Oct 3, 2025
cb8c0ce
Update CONTRIBUTING.rst
euri10 Oct 3, 2025
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
17 changes: 10 additions & 7 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
Contribution Guide
==================

.. _pipx: https://pypa.github.io/pipx/
.. |pipx| replace:: `pipx <https://pypa.github.io/pipx/>`__

.. _homebrew: https://brew.sh/
.. |homebrew| replace:: `Homebrew <https://brew.sh/>`__


Getting Started
---------------

Expand All @@ -19,6 +12,7 @@ At a minimum you will need Python 3.9 for code changes and 3.13 if you plan on d

You can use various tools to manage multiple Python versions on your system including:

* Using `uv built-in <https://docs.astral.sh/uv/guides/install-python/>`_ Python version management.
* `pyenv <https://github.com/pyenv/pyenv>`_ and `pyenv-win for Windows <https://github.com/pyenv-win/pyenv-win>`_
* `rtx / mise <https://mise.jdx.dev/>`_
* `asdf <https://asdf-vm.com/>`_
Expand Down Expand Up @@ -62,6 +56,14 @@ the environment will bootstrap itself automatically. The steps below are for loc
Code contributions
------------------

.. important::
* Documentation PRs are always welcome; it's often a very good entry point to get familiar with the project.
* Bug fixes and small improvements are also a good way to get started. There is no shortage of small things that can be improved.
* The project moves fast; we're humans and may forget about your particular PR. If you feel your PR has stalled, feel free to gently nudge us.
* Large features or refactors may take time. Please be patient; we're all volunteers and want to ensure the best possible outcome.
* Use LLMs intelligently. Most PRs automatically generated are not usable, and incur a higher than normal cost from reviewers and maintainers, as they still need to be thoroughly evaluated, even if they are ultimately not acceptable.


Workflow
++++++++

Expand Down Expand Up @@ -108,6 +110,7 @@ Guidelines for writing code
``docs/reference``. If applicable, add or modify examples in the docs related to the new functionality implemented,
following the guidelines established in `Adding examples`_.


Writing and running tests
+++++++++++++++++++++++++

Expand Down
Loading