Skip to content
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.

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

DOC: fix readme and write precisions on contributing.rst #619

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

C-BdB
Copy link
Collaborator

@C-BdB C-BdB commented Mar 4, 2025

Description

  • Fix the contributing guide URL in the readme.
  • Add precision in contributing.rst

Type of change

Please remove options that are irrelevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Release checklist done.

Checklist

  • I have read the contributing guidelines
  • I have updated the HISTORY.rst and AUTHORS.rst files
  • Linting passes successfully: make lint
  • Typing passes successfully: make type-check
  • Unit tests pass successfully: make tests
  • Coverage is 100%: make coverage
  • When updating documentation: doc builds successfully and without warnings: make doc
  • When updating documentation: code examples in doc run successfully: make doctest

@C-BdB C-BdB requested a review from Valentin-Laurent March 4, 2025 10:32
CONTRIBUTING.rst Outdated
@@ -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.7`, `3.8`, `3.9` or `3.10`. You'll want to activate it every time you want to work on `mapie`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.9 or 3.10 only (versions below are end-of-life)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants