Contribute

Thank you for your interest in helping to improve Matplotlib!

This project is a community effort, and everyone is welcome to contribute. Everyone within the community is expected to abide by our code of conduct.

There are various ways to contribute, such as optimizing and refactoring code, detailing unclear documentation and writing new examples, helping the community, reporting and fixing bugs, requesting and implementing new features...

GitHub issue tracker

The issue tracker serves as the centralized location for making feature requests, reporting bugs, identifying major projects to work on, and discussing priorities.

We have preloaded the issue creation page with markdown forms requesting the information we need to triage issues and we welcome you to add any additional information or context that may be necessary for resolving the issue:

Submit a bug report

Thank you for your help in keeping bug reports targeted and descriptive.

Report a bug

Request a new feature

Thank you for your help in keeping feature requests well defined and tightly scoped.

Request a feature

Since Matplotlib is an open source project with limited resources, we encourage users to also participate in fixing bugs and implementing new features.

Contributing guide

We welcome you to get more involved with the Matplotlib project! If you are new to contributing, we recommend that you first read our contributing guide:

Where should I start?

Where should I ask questions?

How do I work on an issue?

How do I start a pull request?

Contribute code

Code

Write documentation

Documentation

Build community

Community

Development workflow

If you are contributing code or documentation, please follow our guide for setting up and managing a development environment and workflow:

Install

• Setting up Matplotlib for development
  • Fork the Matplotlib repository
  • Retrieve the latest version of the code
  • Create a dedicated environment
  • Install Dependencies
  • Install Matplotlib in editable mode
  • Verify the Installation
  • Install pre-commit hooks

Workflow

• Development workflow
  • Workflow summary
  • Update the main branch
  • Make a new feature branch
  • The editing workflow
  • Open a pull request
  • Update a pull request
  • Manage commit history
  • Automated tests

• Troubleshooting

Policies and guidelines

These policies and guidelines help us maintain consistency in the various types of maintenance work. If you are writing code or documentation, following these policies helps maintainers more easily review your work. If you are helping triage, community manage, or release manage, these guidelines describe how our current process works.

Code

• Coding guidelines
• API guidelines
• Testing

Documentation

• Write documentation
• Documentation style guide
• Tagging guidelines

Triage And Review

• Bug triaging and issue curation
• Pull request guidelines

Maintenance

• Release guide
• Community management guide
• Dependency version policy
• Matplotlib Enhancement Proposals