Skip to content

Commit

Permalink
DOC: fix readme URL and write precisions on contributing.rst (#619)
Browse files Browse the repository at this point in the history
  • Loading branch information
C-BdB authored Mar 6, 2025
1 parent 8ac445f commit af890df
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The typical workflow for contributing to `mapie` is:
Local setup
-----------

We encourage you to use a virtual environment. You'll want to activate it every time you want to work on `mapie`.
We encourage you to use a virtual environment, with Python `3.9` or `3.10`. You'll want to activate it every time you want to work on `mapie`.

You can create a virtual environment via ``conda``:

Expand All @@ -38,7 +38,13 @@ Alternatively, using ``pip``, create a virtual environment and install dependenc
$ pip install -r requirements.dev.txt
Finally, install `mapie` in development mode:
If you work on Mac, you may have to install libomp manually in order to install LightGBM:

.. code-block:: sh
$ brew install libomp
Finally, install ``mapie`` in development mode:

.. code-block:: sh
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ The full documentation can be found `on this link <https://mapie.readthedocs.io/
You are welcome to propose and contribute new ideas.
We encourage you to `open an issue <https://github.com/scikit-learn-contrib/MAPIE/issues>`_ so that we can align on the work to be done.
It is generally a good idea to have a quick discussion before opening a pull request that is potentially out-of-scope.
For more information on the contribution process, please go `here <CONTRIBUTING.rst>`_.
For more information on the contribution process, please go `here <https://github.com/scikit-learn-contrib/MAPIE/blob/master/CONTRIBUTING.rst>`_.


🤝 Affiliations
Expand Down

0 comments on commit af890df

Please sign in to comment.