Skip to content

docs: add contributing guide#265

Open
abdelhadi703 wants to merge 1 commit intomistralai:mainfrom
abdelhadi703:docs/add-contributing-guide
Open

docs: add contributing guide#265
abdelhadi703 wants to merge 1 commit intomistralai:mainfrom
abdelhadi703:docs/add-contributing-guide

Conversation

@abdelhadi703
Copy link
Copy Markdown

Description

Adds a CONTRIBUTING.md file with guidelines for contributors covering:

  • Prerequisites (Python, Poetry, GPU requirements)
  • Development setup and installation
  • Code style (Ruff), type checking (Mypy), and testing (pytest)
  • PR submission workflow and conventions
  • Types of accepted contributions

This repository currently has no contributing guide, which makes it harder for new contributors to understand the expected workflow and quality standards.

Context

The project uses Poetry for dependency management, Ruff for linting (line length 120), Mypy in strict mode, and pytest for testing. All tool configurations are sourced from the existing pyproject.toml.

@abdelhadi703
Copy link
Copy Markdown
Author

Hi @mistralai/team,

Following up on this contributing guide addition. It standardizes contribution guidelines for the repository.

Ready to adjust based on your preferences. Thanks!

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.

1 participant